Tuesday, March 5, 2019

Modern software documentation

Write markdown pages. Use a tool such as Visual Studio Code

Push via wiki, such Docusaurus

Using the same version/source control, such as Github

  • Check-in/out for concurrent updates
  • Versioning for comparison over time

Documentation is part of the product

A product has the lifecycle:

  • Request via Jira
  • Assign to an owner/creator
    • when doc resource is a constraint, prioritize them
  • Reviewed by PM, DEV
  • Verified by QA
  • Release via publishing
  • Change/Correction, Enhancement via Jira

No comments: