Document Writing Skills

Document Writing Skills

Version: 1.0 Created: 2025-11-08 Quality Score: 70/70 (Excellent) Status: Production Ready

Overview

Comprehensive document writing patterns and templates that agents can apply when generating professional documentation, reports, contracts, guides, and technical writing across various domains.

Coverage

Document Types (10+)

• API Documentation: REST/GraphQL/RPC patterns with examples
• Technical Reports: Research reports, incident reports, findings
• Architecture Decision Records: ADR templates with options analysis
• User Guides: Getting started, tutorials, troubleshooting
• Changelogs: Keep a Changelog format with semantic versioning
• Legal Documents: Contracts, memoranda, citations (Finlex/EUR-Lex)
• Security Reports: Vulnerability reports, threat modeling (STRIDE), pentesting
• Product Documents: PRDs, feature specs, user stories, prioritization (RICE/MoSCoW)
• Technical Writing: Style guide, grammar, accessibility (WCAG AA)
• Visual Elements: Code examples, diagrams, tables

Target Agents

• documenter-agent
• legal-agent
• researcher-agent
• developer-agent
• qa-tester-agent
• security-agent
• product-manager-agent

Structure

document-writing-skills/
├── SKILL.md (640 lines)
│   - Core writing principles
│   - Quick-reference templates
│   - Quality checklist
│
└── references/ (2,319 lines)
    ├── legal-document-patterns.md
    │   - Contract templates (employment, service)
    │   - Legal memorandum structure
    │   - Citation formats (Finlex, EUR-Lex, Bluebook)
    │
    ├── technical-writing-guide.md
    │   - Style guide (voice, tense, person)
    │   - Grammar and punctuation
    │   - Accessibility guidelines
    │
    ├── security-report-patterns.md
    │   - Vulnerability reports (CVSS scoring)
    │   - Threat modeling (STRIDE)
    │   - Penetration test reports
    │
    └── prd-patterns.md
        - Product requirement documents
        - User stories and acceptance criteria
        - Prioritization frameworks

Usage

Automatic Triggering

The skill is automatically loaded when agents create documentation. Trigger keywords include:

• "creating API docs"
• "writing user guides"
• "generating reports"
• "drafting changelogs"
• "creating ADRs"
• "writing technical documentation"

Manual Invocation

"Use the document-writing-skills to create [document type]"

Example Requests

API Documentation:

"Create API documentation for a REST endpoint that retrieves user data by ID."

Legal Memorandum:

"Create a legal memorandum analyzing GDPR compliance for email collection."

Product Requirements:

"Create a PRD for a social media scheduling feature."

Security Report:

"Create a vulnerability report for SQL injection in the login form."

Key Features

• Progressive Disclosure: Core patterns in SKILL.md, detailed templates in references
• Copy-Paste Templates: Ready-to-use with clear placeholders
• Quality Checklists: Built-in validation for completeness
• Standards Compliance: Follows industry best practices
• Before/After Examples: Shows improvement patterns

Standards Supported

• Keep a Changelog format
• Semantic Versioning (SemVer)
• ISO 8601 date formats
• WCAG AA accessibility
• CVSS v3.1 scoring
• OWASP Top 10
• STRIDE threat modeling
• RICE/MoSCoW/Kano prioritization

Quality Score: 70/70

License

MIT