tech-doc
Installation
SKILL.md
技术文档协作 Skill
写作基线
- 输出先给结论再解释理由,层级不超过三层,遵循金字塔结构:顶层一句话结论,下一层分解 2–5 个要点,再补充支撑证据。
- 以事实准确为先:不脑补、不擅自扩展原始信息,术语统一且可追溯;必要时保留引用与原始数据。
- 语句保持短句与主动语态,数值带单位,避免模板化口吻; Markdown 标题≤4级,内联代码以反引号标注命令/路径。
- 限定范围与读者:首段交代目标、读者画像、默认前置知识与不在范围内的内容。
介绍/解释型文档
- 用单段开篇说明 What/Why/Outcome,并点出背景、现状与读者对象。
- 列出 2–5 条先结论后佐证的支撑要点,可用要点或短小节。
- 展开时覆盖流程、边界、典型反例;引入新概念应先给直观例子与整体图景,再补充正式定义、场景与不适用情形。
速查/SOP 文档
- 开头一句话描述任务与预期,随后用 1–3 行列表说明适用范围、前置条件、风险或权限,再立刻给最短可用示例。
- 采用“索引 → 分类 → 卡片”结构,每张卡按照“名称/意图 → 最短示例 → 常用参数 → 常见错误 → 相关资料”。
- 不得凭空新增步骤或假设;如需补充,标注“待确认/建议补充”并说明依据。
- 代码块标注
bash/sh,无提示符,命令可直接复制执行;提供占位符说明,必要时给--dry-run或只读版本优先。
Related skills
More from dcjanus/prompts
ticktick-cli
使用 Python CLI 与 Dida365 Open API 交互以管理滴答清单任务/项目,适用于需要通过脚本或命令行调用滴答清单接口的场景(如项目/任务的查询、创建、更新、完成、删除)。
171confluence-cli
查询、检索与阅读 Confluence 文档/页面。
37fetch-url
获取并提取链接正文(默认 Markdown);内置 X/Twitter URL 处理,提升受限页面的抓取成功率。
33github-pr-issue
查看/更新 GitHub Issue、PR(含评论与 diff),并按团队规范非交互创建或修改 PR;涉及 GitHub Issue/PR 的操作时使用。
31dcjanus-preferences
记录 DCjanus 在不同语言中偏好的第三方库与使用场景,供 AI 在选型、引入依赖或替换库时优先参考。适用于 Python/Rust/Go 的库选择、技术方案对比、或需要遵循 DCjanus 个人偏好进行开发的场景。
30golang-lo
Go >= 1.18 项目中希望用 samber/lo(Lodash 风格泛型库)简化集合/映射/字符串、错误处理、重试/节流/防抖、通道并发或指针空值场景时使用。
24