Skip to content
This repository has been archived by the owner on Sep 24, 2022. It is now read-only.

Write The Docs Portland 2022 Release

Alyssa Rock edited this page Apr 17, 2022 · 36 revisions

We can use this space to brainstorm the items for possible inclusion to the project’s inaugural release. Working Groups should feel free to edit within their own sections and add to or refine the items listed there.

Working Group leaders!

Please take a look at the section below for your WG and update it as follows:

  1. Scan the list of existing items and:
    1. Confirm that all the items capture there accurately describe initiatives for your WG, removing them if not, and;
    2. Add any initiatives you know of that are missing.
  2. Ensure each initiative/goal has at least a sentence-long summary, although more is permissible. Feel free also to link to any GitHub issues, kanban boards, or other tools you’re using to manage the details/status of the items.
  3. Provide each item a numerical Priority of 1 through 4, with priority 1 being the highest, and 4 the lowest.
  4. Re-order the rows with the most important item (as determined by your internal discussion) first, and the rest in order of descreasing priority.
  5. Finally, look at the prioritized list of initiatives, and draw a line (literally and figuratively) between the items you feel comfortable committing to for the Portland release, as well as any you’d like to target as stretch goals. The rest can remain on this page, as they’ll form the start of our backlog once we migrate to GitLab.

Project Steering Committee

Goal Description Priority Status
Test out and develop paired writing models
Release process and project management
Create working group leaders guide
Create vice chair role
CoC committee role expansion and training
Improve review process
Member Turnover How to handle situations where community members become inactive on their project and someone wants to take over
Cross-WG Dependency How to handle working group dependencies (when one working group need something from another working group or wants to help)
Define core user base Agree on who our core user base/audience should be
Research how we can meet our target audience better
Start reaching out to dev groups
Promotional Slide Deck Create a slide deck that can be run at dev conferences and meetups
Identify current community pain points
Decide on communication/promotion strategy Create new role(s) if necessary

Chronologue

Goal Description Priority Status
Create MVP version of API Ian wrote an MVP of the Chronologue API using JSON. Ian, Felicity, and I gathered some historic and future events that the mock tool will display. 1 Finished
Design high-fidelity prototype UX Team tests and iterates constantly. The prototype should be finished before Portland 2 In progress
Identify documentation needs and define information architecture [Preliminary documentation plan](https://github.com/thegooddocsproject/chronologue/blob/main/documentation_plan.md) 3 Done
Research doc tools setup The documentation for Chronologue will live in the webite_hugo repository and use the Docsy theme. 4 Done
Stretch Goals
Build mock Chronologue tool We’ll build the mock tool once we have the high-fidelity prototype. Work will start probably after the Portland conference. 1 Pending
Research how to host the mock tool and serve data from API We need to look into how we build the mock tool and host it so it is agnostic of Github. A potential setup could be next.js together with Netlify and Netlify functions for the API. 2 Pending
Create v1 of Chronologue documentation PR: https://github.com/thegooddocsproject/website-hugo/pull/149 3 Pending

Community Docs

Goal Description Priority Status
Tutorial template Merge in the final draft of the Tutorial template High Nearly done
Git onboarding Expand our Git training to the rest of the project Medium Nearly done
Bug issue template Merge in the final draft of the bug issue template Medium Blocked; won’t make it in
Changelog template Begin drafting template Medium In progress
Contributing guide template Begin drafting template Medium In progress
README template Begin drafting template Medium In progress
Our Team template Submit for community review Medium In community review phase
Code of Conduct template Begin drafting template Medium Nearly ready for community review

Content Strategy

Goal Description Priority Status
Conduct User Research Design a questionnaire/survey to gauge user wants.
Outreach Program Identify outlets/communities to initiate contact with.
Create a Newsletter Outline the contents of a newsletter, informed by User Research, and draft an initial copy to be distributed as indicated by the Outreach Program

Doc Tools

Goal Description Priority Status
GitLab migration plan Define our project roles, permissions, and repository structure High In progress; creating an RFC

Glossaries

Goal Description Priority Status
Create a roadmap for the project
Draft the standard format for publishing glossaries

The Good Docs Project Blog

Goal Description Priority Status
Set up social media outlets
Create 5 posts by WTD Portland

Template leads

Goal Description Priority Status
New issue template Create an issue template we can use to build out the work for new templates High Nearly done
Create project board for templates Done: https://github.com/thegooddocsproject/templates/projects/1 High Complete
Handoff from templateers to Chronologuers Need to develop guidelines Medium In discussion
Create organization schema for templates We agreed to create template packs Medium In progress; will complete after Portland
Style guide Build our style guide for templates Medium Will do after Portland
Make a final decision about versioning