This repository has been archived by the owner on Sep 24, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 5
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:
- Scan the list of existing items and:
- Confirm that all the items capture there accurately describe initiatives for your WG, removing them if not, and;
- Add any initiatives you know of that are missing.
- 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.
- Provide each item a numerical Priority of 1 through 4, with priority 1 being the highest, and 4 the lowest.
- Re-order the rows with the most important item (as determined by your internal discussion) first, and the rest in order of descreasing priority.
- 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.
Goal | Description | Priority | Status |
Create co-chair role | We’re going to experiment with having co-chairs | 1 | Complete |
Paired writing | Test out and develop paired writing models in working groups | 2 | Community docs is using this model |
Release process and project management | See template lead updates | 1 | In progress |
Code of Conduct committee | CoC committee role expansion and training | 2 | In discussion; will defer to after Portland |
Define core user base | See Content Strategy | 1 | In progress |
Promotional Slide Deck | See Content Strategy | 2 | In progress |
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 |
Goal | Description | Priority | Status |
Tutorial template | Merge in the final draft of the Tutorial template | 1 | Nearly done |
Git onboarding | Expand our Git training to the rest of the project | 2 | Nearly done |
Bug issue template | Merge in the final draft of the bug issue template | 2 | Blocked; won’t make it in |
Changelog template | Begin drafting template | 3 | In progress |
Contributing guide template | Begin drafting template | 3 | In progress |
README template | Begin drafting template | 3 | In progress |
Our Team template | Submit for community review | 4 | In community review phase |
Code of Conduct template | Begin drafting template | 3 | Nearly ready for community review |
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 |
Goal | Description | Priority | Status |
GitLab migration plan | Define our project roles, permissions, and repository structure | 1 | In progress; creating an RFC |
Goal | Description | Priority | Status |
Create a roadmap for the project | |||
Draft the standard format for publishing glossaries |
Goal | Description | Priority | Status |
Set up social media outlets | |||
Create 5 posts by WTD Portland |
Goal | Description | Priority | Status |
New issue template | Create an issue template we can use to build out the work for new templates | 1 | Nearly done |
Create project board for templates | Done: https://github.com/thegooddocsproject/templates/projects/1 | 1 | Complete |
Handoff from templateers to Chronologuers | Need to develop guidelines | 2 | In discussion |
Create organization schema for templates | We agreed to create template packs | 1 | In progress; will complete after Portland |
Style guide | Build our style guide for templates | 2 | Will do after Portland |
Improve review process | Figure out how to speed up the review process | 2 | In discussion; will complete after Portland |
Make a final decision about versioning |