technical-documentation

---

name: Technical Documentation description: This skill should be used when the user asks to "write documentation", "create README", "API docs", "design document", "specification", "user guide", or needs documentation guidance. Provides comprehensive documentation patterns for developers, teams, and end-users in both English and Japanese.

Copy  [![Badge](https://img.shields.io/badge/example-badge-blue)]

  Brief one-line description of what the project does.

  <features>
    - Feature 1
    - Feature 2
    - Feature 3
  </features>

  <quick_start>
    ```bash
    npm install package-name
    ```
  </quick_start>

  <basic_usage>
    ```typescript
    import { example } from "package-name";

    const result = example();
    console.log(result);
    ```
  </basic_usage>

  <documentation>
    See [full documentation](link) for detailed guides.
  </documentation>

  <contributing>
    Contributions welcome! See [CONTRIBUTING.md](link).
  </contributing>

  <license>
    MIT
  </license>
</example>

Copy  <authentication>
    All requests require an API key in the Authorization header:

    ```bash
    Authorization: Bearer YOUR_API_KEY
    ```
  </authentication>

  <base_url>
    ```
    https://api.example.com/v1
    ```
  </base_url>

  <endpoints>
    <get_users>
      Retrieve a list of users.

      **Parameters:**

      - `limit` (integer, optional): Number of results (default: 10)
      - `offset` (integer, optional): Pagination offset (default: 0)

      **Response:**

      ```json
      {
        "users": [
          { "id": 1, "name": "John Doe" },
          { "id": 2, "name": "Jane Smith" }
        ],
        "total": 100
      }
      ```

      **Error Codes:**

      - `401`: Unauthorized - Invalid API key
      - `429`: Rate limit exceeded
    </get_users>
  </endpoints>
</example>

Copy  <summary>
    **Problem:** Brief description of the problem being solved
    **Solution:** High-level approach
    **Scope:** What's included and what's not
  </summary>

  <background>
    Context and motivation for this design.
  </background>

  <goals_and_non_goals>
    **Goals:**

    - Goal 1
    - Goal 2

    **Non-Goals:**

    - What we're explicitly not doing
    - Future considerations
  </goals_and_non_goals>

  <technical_design>
    <architecture>
      [Diagram or description of system architecture]
    </architecture>

    <data_flow>
      1. User action
      2. System processing
      3. Response
    </data_flow>

    <components>
      **Component A:** Responsible for X
      **Component B:** Responsible for Y
    </components>
  </technical_design>

  <alternatives_considered>
    <alternative_1>
      Pros: ...
      Cons: ...
      Decision: Not chosen because...
    </alternative_1>
  </alternatives_considered>

  <security_considerations>
    - Data encryption at rest and in transit
    - Authentication and authorization
    - Input validation
  </security_considerations>

  <testing_strategy>
    - Unit tests for component logic
    - Integration tests for API contracts
    - E2E tests for critical user flows
  </testing_strategy>

  <rollout_plan>
    1. Phase 1: Internal testing
    2. Phase 2: Beta release (10% of users)
    3. Phase 3: Full rollout
  </rollout_plan>
</example>

Copy  <getting_started>
    Welcome! This guide will help you get started with [Product Name].
  </getting_started>

  <core_concepts>
    **Workspace:** A container for your projects
    **Project:** A collection of related items
    **Item:** The basic unit of work
  </core_concepts>

  <creating_your_first_project>
    1. Click the "New Project" button
    2. Enter a project name
    3. Choose a template (optional)
    4. Click "Create"

    You'll see your new project in the sidebar.
  </creating_your_first_project>

  <troubleshooting>
    <troubleshooting_login>
      1. Check your email address is correct
      2. Click "Forgot Password" to reset
      3. Contact support if the issue persists
    </troubleshooting_login>

    <troubleshooting_data>
      Ensure you have a stable internet connection. The app auto-saves every 30 seconds.
    </troubleshooting_data>
  </troubleshooting>

  <glossary>
    **Term:** Definition
    **Another Term:** Another definition
  </glossary>
</example>

<best_practices> Audience-first approach - Write for your specific audience's knowledge level Developers: Assume technical background, focus on implementation details Team members: Balance context with technical depth End users: Avoid jargon, use step-by-step instructions

<language_guidelines> Active voice, present tense Professional but approachable Unnecessarily complex words, idioms that don't translate <good_example>Good</good_example> Run this command to start the server.

Copy  <bad_example>Bad</bad_example>
  The server can be started by running the following command.
</example>

Copy  <bad_example>Bad</bad_example>
  サーバーの起動については、下記コマンドを実行することで可能となります。
</example>

Copy<structure>
  [Proposed sections based on document type]
</structure>

<content>
  [Actual documentation content]
</content>

<review_checklist>
  - [ ] Technical accuracy verified
  - [ ] Code examples tested
  - [ ] Links working
  - [ ] Appropriate for audience
  - [ ] Grammar and spelling checked
</review_checklist>

<anti_patterns> Long paragraphs without formatting Break into smaller paragraphs, use bullet points, headings, and code blocks

<error_escalation> Minor formatting inconsistency Fix formatting, follow style guide Outdated information detected Update content, verify with code Incorrect technical information Stop, verify with implementation before publishing Security-sensitive information exposed Block publication, require security review </error_escalation>

<related_skills> Symbol operations for extracting code examples and API signatures Library documentation lookup for accurate API references Analyzing codebases to understand features for documentation Creating blog posts and tutorials from documentation </related_skills>