documentation
Write and maintain technical documentation. Trigger with "write docs for", "document this", "create a README", "write a runbook", "onboarding guide", or when the user needs help with any form of technical writing — API docs, architecture docs, or operational runbooks.
- License 许可
- MIT
- 所属仓库
- meymchen/skills
- 最近更新
- 2026-10-16
- Stars
- ★ 0
- Forks
- 0
01 前言 Front Matter
- name
- documentation
- description
- Write and maintain technical documentation. Trigger with "write docs for", "document this", "create a README", "write a runbook", "onboarding guide", or when the user needs help with any form of technical writing — API docs, architecture docs, or operational runbooks.
- user-invocable
- true
- disable-model-invocation
- false
02 资源文件 1
- 参考文档agents/openai.yaml187 B
03 SKILL.md 正文
<!-- Adapted by Yuming Chen on 2026-10-04 for personal use and dual-host support. See ../../UPSTREAM.md. -->
Technical Documentation
Read CONNECTORS.md for host invocation, personal use, and optional tools.
Write clear, maintainable technical documentation for different audiences and purposes.
Document Types
README
- What this is and why it exists
- Quick start (< 5 minutes to first success)
- Configuration and usage
- Contributing guide
API Documentation
- Endpoint reference with request/response examples
- Authentication and error codes
- Rate limits and pagination
- SDK examples
Runbook
- When to use this runbook
- Prerequisites and access needed
- Step-by-step procedure
- Rollback steps
- Escalation path (if applicable; otherwise recovery references)
Architecture Doc
- Context and goals
- High-level design with diagrams
- Key decisions and trade-offs
- Data flow and integration points
Onboarding Guide
- Environment setup
- Key systems and how they connect
- Common tasks with walkthroughs
- Maintainer notes and, for team projects, who to ask for what
Principles
- Write for the reader — Who is reading this and what do they need?
- Start with the most useful information — Don't bury the lede
- Show, don't tell — Code examples, commands, screenshots
- Keep it current — Outdated docs are worse than no docs
- Link, don't duplicate — Reference other docs instead of copying
04 同仓库更多 Skills
cleanup-merged-branch
Safely clean a merged local branch, reproducible worktree caches, and stale local branches before updating the repository default branch.
verify-acceptance-items
Verify a GitHub pull request or GitLab merge request (MR) against the acceptance criteria (验收标准/条件, task-list checkboxes) of the issues it links to, then tick the criteria it proves once the user confirms. Use when asked whether a PR or MR is done or meets its issue, when asked to check off an issue's checkboxes, or right after opening or updating a PR or MR that closes an issue.
update-request-body
Update the title and body of one or more GitHub pull requests or GitLab merge requests (MRs).
commit
Create a Git commit from the current changes.
commit-push-request
Commit current changes, push the branch, and open a GitHub pull request or GitLab merge request (MR).
clean-gone
Remove local Git branches whose upstreams are gone, including associated worktrees.