PickSkill
← Back

documentation

技术文档编写规范 - README、任务分配文档、开发指南、部署文档

SKILL.md
Rendered from GitHub raw
View raw ↗

name: documentation description: 技术文档编写规范 - README、任务分配文档、开发指南、部署文档

  • 编写markdown文档
  • 创建任务分配有追踪文档
  • 编写开发指南和部署文档

文档在docs目录下,根据文档类型进行分类存放,如docs/tasks等。

  1. 使用 markdown 格式编写,遵循 GitHub Flavored Markdown 规范
  2. 结构清晰,使用标题、列表、表格和代码块组织内容,包括Alert,折叠等。
  3. 语言简洁明了,避免冗长和复杂句子
  4. 使用适当的emoji增强可读性

<must_not>

  • ❌ 不要编造不存在的功能或 API
  • ❌ 不要复制粘贴代码作为文档(应提取关键信息)
  • ❌ 不要忽略错误场景的文档(只写成功路径)
  • ❌ 不要使用模糊的描述(如"可能"、"或许"、"大概")

</must_not>