About

Imported from practicalswan/agent-skills (documentation-patterns/SKILL.md). Install upstream with npx skills add practicalswan/agent-skills --skill documentation-patterns. Copyright stays with the author.

Documentation Patterns

Name: documentation-patterns
Author: practicalswan

Use this skill when the main problem is document shape and consistency rather than writing quality alone.

Leverage native parallel subagent dispatch and 200k+ context windows where available.

Activation Conditions

Use symptom -> action triggers: when one matches, apply this skill and verify with the protocol below.

Creating a new API, feature, or config guide
Standardizing Markdown sections across repositories
Writing migration or runbook documents
Picking the right template for a doc request

Pattern Selection

API docs: endpoints, auth, request and response schema, errors
Feature docs: purpose, UX, dependencies, rollout, support
Config docs: env vars, defaults, examples, failure modes
Migration docs: changed behavior, upgrade path, verification

Cross-Skill Workflow

Use documentation-authoring to gather context and draft the content before template selection becomes the bottleneck.
Use this skill when structure, section order, or template choice is the main problem.
Finish with documentation-quality to review the final document against quality expectations.

Agent Prompt Template

Use the documentation-patterns skill to choose and apply the best structure for a [document type].
Context: [feature, system, migration, or runbook].
Bias toward: [API docs, feature docs, config guide, migration guide, etc.].
Return the recommended section outline with short notes on why each section exists.

Shared Documentation Stack

Use this as the inherited baseline for documentation-authoring, documentation-quality, documentation-automation, and documentation-verification.

Source of truth: identify owner, audience, canonical files, and freshness requirements before drafting.
Structure: choose the smallest reusable pattern that fits the reader task.
Verification: check links, commands, examples, screenshots, and version-sensitive claims before publishing.
Handoff: state unresolved gaps, owners, and next review trigger instead of implying false completeness.

Anti-Patterns

Writing for the author instead of the reader: It bakes in unstated context and leaves the actual audience unsure what to do next.
Skipping concrete examples or commands: Abstract guidance is easy to approve and hard to apply correctly.
Letting links, screenshots, or versions drift: Polished formatting does not help if the instructions are no longer true.

Verification Protocol

Before claiming "skill applied successfully":

Pass/fail: The Documentation Patterns output identifies audience, purpose, source of truth, and freshness requirements.
Pass/fail: Shared documentation-stack guidance is referenced instead of duplicating another documentation skill.
Pass/fail: Claims, links, commands, examples, and screenshots are verified or explicitly marked unverified.
Pressure-test scenario: Apply the skill to a doc request with a stale command, missing owner, and conflicting audience.
Success metric: Zero undocumented assumptions; every reader-facing claim is sourced or scoped.

References & Resources

Documentation

API Documentation Templates - Endpoint, SDK, and function documentation patterns
Feature Documentation Templates - Feature overview, rollout, and troubleshooting patterns
Configuration Documentation Templates - Config and environment variable templates

Scripts

Doc Template Picker - Print a starter Markdown template for api, feature, config, or migration

Cross-Client Portability

This skill is written to stay usable across GitHub Copilot, Claude Code, and Codex.

GitHub Copilot: keep the folder in a Copilot-visible skill path or wrap the workflow in project instructions when folder discovery is unavailable.
Claude Code: keep the folder in a local skills directory or a compatible plugin source.
Codex: install or sync the folder into $CODEX_HOME/skills/documentation-patterns and restart Codex after major changes.

MCP Availability And Fallback

Preferred MCP Server: None required

Fallback prompt: "Use the Documentation Patterns skill without MCP. Rely on the local SKILL.md, bundled references or scripts, and manual verification. Show the exact commands, evidence, and final checks you used before concluding."
If the current host does not expose a matching server, use the bundled references, scripts, native toolchain, and manual workflow already described in this skill.
Treat direct local verification, rendered output, logs, tests, or screenshots as the fallback evidence path before completion.

Related Skills

documentation-authoring: Use it when the workflow also needs drafting structured technical or product documents.
documentation-quality: Use it when the workflow also needs documentation review standards and quality gates.
documentation-verification: Use it when the workflow also needs final documentation validation before publishing.
notion-docs: Use it when the workflow also needs Notion page and database publishing workflows.

Use it

Copy one of these into your project. Installing also returns the manifest and these snippets.

yaml

targets:
  - https://api.opensmartroute.ai/api/v1/registry/practicalswan-agent-skills-documentation-patterns/manifest   # or paste the manifest below

Manifest

An Open Capability Manifest: the router reads it to know what this does, what it costs and when to pick it.

practicalswan-agent-skills-documentation-patterns.ocm.jsonjson

{
  "ocm": "1",
  "id": "practicalswan-agent-skills-documentation-patterns",
  "kind": "skill",
  "name": "documentation-patterns",
  "description": "Templates and structural patterns for API docs, feature docs, config guides, and REST endpoint documentation. Use when structuring docs, applying Markdown templates, or standardizing doc formats.",
  "publisher": "practicalswan",
  "version": "1.0.0",
  "capabilities": {
    "domains": [
      "coding"
    ],
    "tags": [
      "skill-md",
      "documentation",
      "patterns",
      "docs",
      "writing",
      "quality",
      "skills-sh"
    ],
    "languages": [
      "en"
    ]
  },
  "quality_prior": 0.6,
  "examples": [
    "Templates and structural patterns for API docs, feature docs, config guides, and REST endpoint documentation. Use when structuring docs, applying Markdown templates, or standardizing doc formats."
  ],
  "primary": false,
  "metadata": {
    "source": {
      "provider": "skills.sh",
      "repository": "https://github.com/practicalswan/agent-skills",
      "path": "documentation-patterns/SKILL.md",
      "ref": "HEAD",
      "url": "https://github.com/practicalswan/agent-skills/blob/HEAD/documentation-patterns/SKILL.md",
      "key": "practicalswan/agent-skills/documentation-patterns/SKILL.md"
    }
  },
  "instructions": "# Documentation Patterns\n\nUse this skill when the main problem is document shape and consistency rather than writing quality alone.\n\n- Leverage native parallel subagent dispatch and 200k+ context windows where available.\n\n\n## Activation Conditions\n\nUse symptom -> action triggers: when one matches, apply this skill and verify with the protocol below.\n\n- Creating a new API, feature, or config guide\n- Standardizing Markdown sections across repositories\n- Writing migration or runbook documents\n- Picking the right template for a doc request\n\n## Pattern Selection\n\n- API docs: endpoints, auth, reques",
  "cost": {
    "context_tokens": 1379
  }
}

Fetch it by URL: GET /api/v1/registry/practicalswan-agent-skills-documentation-patterns/manifest?version=1.0.0

Reviews

Star ratings from people who tried it. One review per account; edit yours any time.

No reviews yet. Install it, try it, and be the first to rate it.