Create a Guide/Template: Documentation Technologies

[CalvinTan607]

Overview

We need to create a guide to making a storage for your documentation, therefore we will write a guide discussing different documentation technologies that are available.

Action Items

The phases in the guide-making process are listed below. Each phase displayed in blue is linked to a wiki page with instructions on how to complete that phase. Open the wiki page in a new tab, copy the instructions for each part into the section labeled 'Tasks' at the bottom of this issue, and complete each task listed.

• Gather Examples Solo (open in a new tab)
• Gather Examples Collaboratively
• Create a Guide Draft
  • If needed, create a template
• Have your guide peer reviewed
• Present your guide for leadership review

Resources/Instructions

Projects to Check

Tasks

• This is where you will copy instructions from the wiki page for the step you are currently on.

[JesseTheCleric]

Prior version of issue

Overview

We need to create a guide to making a storage for your documentation, therefore we will write a guide discussing different documentation technologies that are available.

Action Items

• Gather examples of how other projects have done it, adding each example as a link in the resources section
  • Once done, remove the "TG: Gather Examples" label and add the "TG: Draft Template" label
• Create a draft template, either in markdown format in this issue or a google doc in the Engineering google drive
  • Once done, remove the "TG: Draft Template" label and add the "TG: Create Guide" label
• Create a guide on how to use the template
  • Once done, remove the "TG: Create Guide" label and add the "TG: Review Guide" label
• Review the guide with product management communities of practice
  • Once done, remove the "TG: Review Guide" label and add the "TG: Leadership Review" label
• Present to Hack for LA leadership team for sign off
  • Once approved, remove the "TG: Leadership Review" label and add the "TG: Place Guide" label
• Possibly create an issue template on .github
  • Include link to template under resources if you add it as a template in .github

Resources

Update tracker issue (TBD) with the name of item you are working

[JesseTheCleric]

Assignee, Labels, Project Board Placement, and Milestones for this issue in the Engineering Repo: