software documentation guidelines

documentation.txt

Software documentation types:
https://ibb.co/0s7W7TD

Key topics to document
- Architecture of how microservices or system components interact with each others
- Decision documents
- architecture of each component or microservice on its own
- When/How to run Migrations and how to generate
- Design System documentation / storybook if applicable
- GUI for the database?
- Connecting to the database via SSH
- Automated backups?
- Release notes
- Technologies used, why/what they do including third party dependencies/apis/libraries
- Roles and Permissions / Personas in the system
- Deployment, how to deploy, deployment process
- Development workflow including branching, naming conventions if any & review process, Release & versioning management / lifecycle
- CI/CD workflows and their triggers and what they do
- Feature documentation both PRD(Product requirements document) and implementation (including highlighting of guidelines or limitations like the softdeletion/status feature)
- Read me files explaining how to run each repo and install the needed technologies to run it
- API documentation - in GraphQL schemas or swagger
- Glossary documentation for buzzwords:Technical and product
- Testing
- User documentation / manual: How to use the product and each feature can be served as a client document
- System Admin documentation / manual: How do I enable/disable a feature, create users, do chore support tasks, etc..

Keytopics each document should include
- Audience
- Prerequisites: recommended previous learning, tools to install, etc..
- Description / Introduction; about the document and what it describes
- How it works or the What
- Concerns, Limitations & Known issues
- Future plans
- Questions

Process documentation:——Products docs:
https://www.altexsoft.com/blog/business/technical-documentation-in-software-development-types-best-practices-and-tools/