Create an example of a Chronologue Installation Guide
Issue: Chronologue Installation guide
The main goal of the Chronologue project is to write examples of good documentation by testing templates created by the templates team. Use this issue to create a Chronologue documentation example for the Installation guide template. Link to template in the repository: Installation guide
Link to Google Doc drafts
To keep ownership and manage an archive of the drafts, The Good Docs Project has pre-generated Google doc files for you to test templates and document your process.
-
Decision log - Installation decisions. -
Friction log - Installation friction. -
Document file - Installation documentation.
Bookmark these links and use them during your writing process. You can always consult the links in this issue.
To know more about the drafting process, please read the Cronologue Contributing Guide.
Definition of done
We consider a document finished when it has gone through all the writing stages and it has (at least) a document file and a link to it in the {template name} repository.
Writing stages
-
Research stage (optional). For any Chronologue-building decisions your documentation requires, use the Decision log file to document these decisions and any resources you might use. For example, to write an installation guide, you may need to invent a third-party app that allows you to view astronomic Chronologue recordings in a VR headset. You would use the Decision log file to document the creation process of this new feature. -
Drafting stage. Test your template and draft your document in the Document file. During this stage you can also document the friction points you find when using the template in the Friction log file. -
Community review stage. Communicate to your working group leaders when your draft is ready for review by the team. They will schedule a session where team members will read and provide feedback to your document. -
Template feedback (optional). If you have any feedback to improve the template you tested, open an issue directly in the templates reporsitory. You can upload the Friction log file. Make sure to give actionable feedback in the issue. -
Final review stage. After the team has reviewed your draft at least one time, you can convert your Google doc into a Markdown file and open a merge request in the Documentation repository. Chronologue leads may ask for additional changes. After the group leads approve your document, you can merge it.
Chronologue deliverables
-
Document file. -
Link to Chronologue example in the {template name} repo. -
Decision log file (if applicable). -
Issue in templates repository to provide feedback (if applicable).
Working on this issue
Check that the issue is unassigned. If it is assigned, you might be able to work with the current assignee as a paired writer. Follow these requirements to work on this issue:
- Join The Good Docs Project by attending a Welcome Wagon meeting and ask the community managers to invite you to The Good Docs Project Slack workspace.
- Read the Chronologue Contributing Guide.
- Attend one of our Chronologue working groups regularly to receive support, mentorship, resources, and feedback.
API calls installation guide for two in world VR headsets.
- CLI possible
- connect to computer