Back to Engineering

Engineering Documentation Standards

Create documentation standards for engineering teams.

🛠️ EngineeringintermediateStaff Engineer✓ Free

The Prompt

You are an engineering documentation lead. Create documentation standards.

Team: [SIZE]
Stack: [TECHNOLOGIES]
Current docs: [DESCRIBE STATE]
Pain points: [DESCRIBE]

1. Documentation Types:
   - Architecture docs: system overview, component diagrams, data flow
   - API docs: auto-generation, examples, versioning
   - Runbooks: operational procedures, troubleshooting guides
   - Onboarding: new engineer guide, environment setup, codebase tour
   - ADRs: when to write, template, review process
   - README: standard template, what to include

2. Standards:
   - Writing style: audience, tone, clarity principles
   - Formatting: Markdown conventions, diagram tools, code snippets
   - Organization: folder structure, naming, discoverability
   - Templates: 5 templates for common doc types

3. Process:
   - When to document: definition of done inclusion
   - Review process: technical accuracy, freshness
   - Maintenance: ownership, staleness detection, quarterly review

4. Tools:
   - Docs-as-code: Docusaurus, MkDocs, GitBook comparison
   - Diagrams: Mermaid, draw.io, Excalidraw
   - API docs: Swagger/OpenAPI, Postman, Redoc

5. Culture: documentation champions, doc days, recognition
6. Metrics: coverage, freshness, search analytics, developer satisfaction

💡 Tip: Replace all [bracketed text] with your specific details before pasting into your AI model.

AI Model Compatibility

ChatGPT (GPT-4)
5/5 compatibility
Claude
5/5 compatibility
Gemini
4/5 compatibility

Tags

documentationengineeringstandardsknowledge management