문서화

technical-documentation

Creates and reviews practical technical documentation such as READMEs, API references, CLI help, configuration guides, troubleshooting content, and agent-facing instructions.

★ 88 GitHub Stars
88 품질 점수
7 파일

이 Skill 소개

Create and review technical documentation, including READMEs, agent-facing instructions, API references, and CLI help. Use when documentation must help someone complete real work. Do not use for marketing copy, brand messaging, or long-form editorial content.

사용 사례

  • Writing or restructuring project READMEs
  • Documenting APIs and endpoint behavior
  • Designing CLI help text and usage guidance
  • Creating agent-facing instructions and skill documentation
  • Structuring reference and troubleshooting documentation

기능

  • README patterns and quickstart guidance
  • API documentation conventions and examples
  • CLI help, flags, exit codes, and subcommand guidance
  • Agent-facing documentation guidance
  • Documentation information architecture and cross-referencing principles

지원 Agent

지정되지 않음

Skill 파일

관련 Skills

adr-authoring

Helps agents write, review, and maintain architecture decision records with documented context, alternatives, consequences, approval scope, evidence, confirmation links, and lifec…

magnus919/agent-skills ★ 88
architecture decisions adr technical documentation decision records

mermaid-diagrams

Enables agents to author, render, troubleshoot, and review Mermaid diagrams for documentation, architecture, processes, and technical communication across web, Markdown, SVG, PNG,…

magnus919/agent-skills ★ 88
mermaid diagrams flowcharts sequence-diagrams

open-knowledge-format

Create, structure, and validate portable Open Knowledge Format (OKF) v0.1 bundles composed of Markdown concepts, YAML frontmatter, indexes, and cross-links.

magnus919/agent-skills ★ 88
okf knowledge-format knowledge-bundles llm-wiki

confluence-cli

Enables agents to use a terminal CLI for listing Confluence spaces, browsing and viewing pages, searching with CQL, and creating pages through the Confluence REST API.

magnus919/agent-skills ★ 88
confluence atlassian wiki documentation

sourcesage-cli

Guides Codex in using the SourceSage CLI to generate repository summaries, including lite mode, language selection, custom output directories, and deprecated tag-diff reports.

Sunwood-ai-labs/SourceSage ★ 72
sourcesage repository-summary cli documentation

openclaw-docs

Guides agents in finding and applying synchronized OpenClaw documentation for installation, configuration, operations, security, troubleshooting, integrations, and CLI tasks.

tbdavid2019/openclaw-docs-skill ★ 32
openclaw documentation cli gateway