SuperAPI AI Directory

documentation-standards

Writing & research

View repository

Updated 10-15 22:11

About this skill

Documentation Standards Skill

🔴 AI FIRST Quality Principle

Apply the AI FIRST principle: never accept first-pass quality. Minimum 2 iterations. Read all output, improve every section. No shortcuts.

Purpose

Ensure consistent, high-quality technical documentation following C4 architecture model and Hack23 standards.

Document Structure Template

# Title - [Purpose]

Document Version: X.X Last Updated: YYYY-MM-DD Classification: [Public/Internal] Owner: Hack23 AB (Org.nr 5595347807)

Executive Summary

[High-level overview]

1. Main Content

[Sections with diagrams]

Related Documentation

[Links to related docs]


Document Control:

  • Repository: [URL]
  • Path: /DOCUMENT.md
  • Format: Markdown with Mermaid
  • Next Review: YYYY-MM-DD

## C4 Architecture Model

### Level 1: System Context
```mermaid
graph TB
    User[Users]
    System[System]
    External[External System]
    
    User --> System
    System --> External

Level 2: Container

graph TB
    subgraph "System"
        App[Application]
        DB[Database]
    end
    
    User --> App
    App --> DB

Level 3: Component

graph TB
    subgraph "Application"
        Controller[Controller]
        Service[Service]
        Repository[Repository]
    end

Mermaid Diagram Best Practices

  1. Use clear, descriptive labels
  2. Consistent styling with subgraphs
  3. Appropriate diagram types
  4. Color coding for clarity
  5. Legend when needed

Remember

  • Clarity First: Easy to understand
  • Consistency: Follow standards
  • Visual: Use diagrams
  • Completeness: All required docs
  • Maintenance: Regular reviews

References