← Voltar para o catálogo
技术协作场景下撰写与维护高质量技术文档的统一写作指南。
Ver no GitHub ↗
Como adicionar
/plugin marketplace add bg-szy/TOP-SKILLS
O comando exato pode variar conforme o repositório. Confira o README no GitHub.
Para o autor da skill
Cole no README do seu repo
Mostra que sua skill está catalogada na Skillteca, gera backlink e tráfego rastreável.
[](https://www.skillteca.com.br/skills/tech-doc-bg-szy)
Alerta por categoria
1 email curto, só com as skills novas de Pesquisa e Web. 4 minutos de leitura, sem spam, cancela com 1 clique.
Você confirma o email no primeiro envio. Sem spam. Cancela com 1 clique.
Ler descrição completaRecolher descrição
技术文档协作 Skill
写作基线
- 输出先给结论再解释理由，层级不超过三层，遵循金字塔结构：顶层一句话结论，下一层分解 2–5 个要点，再补充支撑证据。
- 以事实准确为先：不脑补、不擅自扩展原始信息，术语统一且可追溯；必要时保留引用与原始数据。
- 语句保持短句与主动语态，数值带单位，避免模板化口吻； Markdown 标题≤4级，内联代码以反引号标注命令/路径。
- 限定范围与读者：首段交代目标、读者画像、默认前置知识与不在范围内的内容。
介绍/解释型文档
- 用单段开篇说明 What/Why/Outcome，并点出背景、现状与读者对象。
- 列出 2–5 条先结论后佐证的支撑要点，可用要点或短小节。
- 展开时覆盖流程、边界、典型反例；引入新概念应先给直观例子与整体图景，再补充正式定义、场景与不适用情形。
速查/SOP 文档
- 开头一句话描述任务与预期，随后用 1–3 行列表说明适用范围、前置条件、风险或权限，再立刻给最短可用示例。
- 采用“索引 → 分类 → 卡片”结构，每张卡按照“名称/意图 → 最短示例 → 常用参数 → 常见错误
[Description truncada. Veja o README completo no GitHub.]
Compartilhar
X
LinkedIn
