Agent Skills
› NeverSight/learn-skills.dev
› tech-impl-doc
tech-impl-doc
GitHub生成精准的技术实现文档，区分用户与开发者受众。包含结构规范、无冗余内容要求及防解析错误的Mermaid图表绘制指南，确保代码路径准确和可点击链接。
触发场景
请求编写技术实现文档
需要架构或设计深度解析
生成系统操作指南
安装
npx skills add NeverSight/learn-skills.dev --skill tech-impl-doc -g -y
SKILL.md
Frontmatter
{
"name": "tech-impl-doc",
"description": "Write precise technical implementation docs (developer or user) with clear structure, accurate flows, render-safe Mermaid diagrams, and audience-appropriate detail; avoid boilerplate; include a meaningful Code Index for developer docs."
}
Technical Implementation Doc Skill
When to use
- The user asks for an implementation doc, technical deep dive, architecture/design write-up, or a user guide describing how a system works.
Confirm up front
- Audience: user / developer / mixed.
- Scope: which features or subsystems to cover.
- Output location and language.
- Diagrams: include Mermaid for multi-step flows unless the user says not to.
Audience rules
User-facing docs
- No code locations or internal class names unless explicitly requested.
- Focus on configuration, behavior, and operational steps.
- Use direct clickable links (raw URLs). Do not hide references behind footnotes.
- Avoid boilerplate: no “this document describes…”, no “version info”, no filler headings.
Developer-facing docs
- Include code paths and line numbers.
- Add a Code Index: each entry must explain what the code is responsible for.
- Call out constraints, failure modes, and trade-offs.
Structure rules
- Headings must be meaningful (no parenthetical fluff like “(quick copy)” or “(notes)”).
- Prefer numbered sections for complex systems.
- Keep intro minimal; skip generic explanations.
Mermaid rules (avoid parse errors)
- Keep node labels simple; avoid parentheses and heavy punctuation in labels.
- If a label must contain special characters, wrap it in quotes.
- Avoid line breaks inside labels.
- Use simple node IDs (A, B, C…).
Safe example:
flowchart TB
A["buildRemotePlan (query_port)"] --> B["CrossClusterMergeStep"]
Workflow
- Identify audience and constraints.
- Scan existing docs; consolidate instead of duplicating.
- Verify claims against source code or authoritative docs.
- Draft core flow first (request path → execution → merge → output).
- Add Mermaid diagrams for key flows.
- Add constraints/unsupported features section.
- Add Code Index with descriptions (developer docs only).
- Final pass to remove boilerplate and meaningless headings.
Output checklist
- Audience-appropriate detail level.
- No redundant intro/version sections unless requested.
- Mermaid diagrams render without parse errors.
- Code Index entries explain their purpose (developer docs only).
- Links are clickable in user docs.
版本历史
- e0220ca 当前 2026-07-05 22:59
