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

Modern Product Documentation

Here are requirements from user and product interaction perspectives:

• We should not require people to download docs from somewhere else.  Links to docs should be available within the product.  PDF is fine but context sensitive contents are better.
• Use videos to demonstrate How-Tos.  Again, links should be available within the product
• Show Release Note directly with the product
• Allow the users to directly enter a support case within the product
• Allow the users to provide suggestions directly from the product
• A small News&Update - directly communicate to your users

This is the modern software should be and I just saw one!!

Colons and commas are important

Woman without her man has no reason for living.


Woman: without her, man has no reason for living.