Documentation structure
Meta-Doc
How to create documentation that respects the structure of the project
- How to doc
- Documentation example
- Documentation bad example
- How to readme
- How to tech
- Documentation structure
Enterprise
To help new developers get started with the projects and the organisation
- adr-template
- organisation
- organisation-overview
- organisation-history
- organisation-structure
- onboarding
- team-overview
- permissions
- internal-tools
- …
FrontEnd
For the frontend
- Bundle
- React project
- Setup
- Security
- Tech
- Deprecated
- …
BackEnd
For the backend
- Security
- Tech
- Deprecated
- …
Infrastructure
For the infrastructure
- CI-CD
- Docker
- Security
- Tech
- Deprecated
- …
Security
For the security of the projects
- Passwords
- Secrets
- Compliance
- …
Quality Assurance
For the quality assurance on the organisation
- Issue
- Ticket
- Signalement
- …
…
Exemple :
Scenario 1: A developer wants to document how to use a specific technology in the project.
Scenario: A developer wants to document how Redis is used in one backend project.
Solution:
- Put general Redis usage in tech/redis.md (how we use it at org-level)
- Put project-specific patterns in backend/projectX/redis-usage.md (??)
Scenario 2: General ideas
Scenario: Fake Senario
Solution:
- what to do
- in step
Last updated on