Add Good Docs Project Method section to website
What is The Good Docs Project Method?
For the Capilano release, the template product managers decided to add a new type of content to the template roadmap. This new content is called The Good Docs Project method, also called "method articles" for short. From the templates CONTRIBUTING guide:
The Good Docs Project regularly takes in requests from users and stakeholders about what types of content they would like us to provide. Sometimes we receive requests for content that won't make sense as a template and instead would make more sense as an article or blog entry.
We call these types of articles methods and publish them on our website under a section called The Good Docs Project methods. Articles written for this framework are titled using the {Article Title} Method, such as the Docs Landing Page Method.
Method projects go through the same contributing process as templates, but are published on our website instead of in the template repository.
What needs to be done?
Our goal is to add a new section to the website for The Good Docs Project method. We'd like to have it styled in a similar way to the GitHub Open Source Guides.
It will initially feature two articles:
- @anita-ihuman 's Docs Landing Page article
- Lana Brindley's Information Architecture article
In the future, we'll add additional method articles that are planned for the template roadmap. See: Template issue backlog - Method articles.
Impact - 8
What benefits will come from this goal or task?
We'll be able to provide educational resources about documentation best practices by writing content that has been requested by our users, but which don't quite make sense as templates.
Reach - 8
Who will benefit from this goal or task and for how long? Our immediate community? Our users? Perhaps beyond?
This task will benefit our users and the technical writing industry as a whole.
Community/Goodwill - 5
How will it promote the well-being of our community or good will toward our project?
These resource guides could help our users who need guidance beyond templates. It can educate them about documentation best practices or how to do complex tasks that a template can't help them with.
Effort - 8
How difficult will it be to complete this goal or task? How much effort will be required? Will it require individual effort or cross-team collaboration?
This project will require likely 2-3 months of weekly co-working meetings to get this task accomplished.
Confidence - 90%
We're confident we can get this task done!
Final weight: 67