technical-documentation
Write clear, accurate, and maintainable technical documentation for APIs, systems, architecture, and developer-facing content. Use when creating or improving API docs, architecture docs, developer guides, or internal technical references.
- License 许可
- MIT
- 最近更新
- 2026-07-22
- Stars
- ★ 7
- Forks
- 1
01 前言 Front Matter
- name
- technical-documentation
- description
- Write clear, accurate, and maintainable technical documentation for APIs, systems, architecture, and developer-facing content. Use when creating or improving API docs, architecture docs, developer guides, or internal technical references.
03 SKILL.md 正文
Technical Documentation
Overview
Good technical documentation reduces support burden, speeds onboarding, and prevents knowledge loss. It prioritizes accuracy, discoverability, and the reader’s task.
When to Use
- API reference and guides
- Architecture and design documentation
- Developer onboarding and how-to guides
- Internal system documentation
- Runbooks that require technical depth
Core Principles
- Write for the reader’s goal (solve a problem, integrate, understand a system)
- Prefer concrete examples over abstract descriptions
- Keep documentation close to the code when possible
- Version docs with the system they describe
- Distinguish reference (what) from tutorials (how) from explanation (why)
- Make the happy path obvious; document edge cases and errors clearly
Recommended Structure (API / System Docs)
- Overview and purpose
- Quickstart / getting started
- Core concepts
- Reference (endpoints, schemas, configuration)
- Examples and recipes
- Error handling and troubleshooting
- Changelog / versioning notes
Verification
- [ ] A new reader can complete a basic task using only the docs
- [ ] Examples are accurate and up to date
- [ ] Ambiguous terms are defined
- [ ] Error cases and limits are documented
04 同仓库更多 Skills
compliance-monitoring
Design compliance monitoring and testing programs that verify controls work in practice and surface issues before regulators do. Use when building monitoring plans, compliance testing, or continuous control monitoring.
complaints-handling
Operate complaints-handling processes that meet regulatory standards — logging, timely resolution, root-cause analysis, and fair outcomes. Use when designing or improving regulated complaints frameworks or analyzing complaint themes for conduct risk.
aml-kyc-basics
Apply AML/KYC fundamentals — customer due diligence, monitoring, suspicious activity escalation, and recordkeeping — for financial crime compliance. Use when designing onboarding controls, transaction monitoring concepts, or AML program components in financial services.
ai-model-compliance
Apply compliance controls to AI and automated decision systems — transparency, fairness, human oversight, documentation, and regulatory alignment. Use when deploying AI in regulated processes (credit, fraud, customer decisions) or responding to AI governance expectations.
data-quality-management
Manage data quality end-to-end — dimensions, rules, remediation, and prevention — beyond one-off cleaning scripts. Use when building sustained data quality programs or fixing systemic accuracy, completeness, or consistency problems.
data-lineage
Capture and use data lineage — where data comes from, how it transforms, and what depends on it — for impact analysis, debugging, and trust. Use when tracing metric origins, assessing change impact, or diagnosing broken pipelines.