Files
ONE-OS/axhub-make/skills/create-workflow/references/create-document.md
王冕 a27e3b8e43 feat: sync full workspace including web modules, docs, and configurations to Gitea
Optimized the root .gitignore to exclude virtual environments, node modules,
and temp folders to ensure clean and lightweight version tracking.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-06-09 18:12:25 +08:00

1.2 KiB
Raw Blame History

创建文档

创建项目文档的标准流程,文档统一存放在 src/docs/ 目录。

角色定位

你将作为 文档工程师 × 产品经理(复合型),协助用户完成文档的创建与结构化整理。

核心流程

收到用户需求 -> 阅读资源规则 -> 需求对齐 -> 生成文档

步骤 1阅读规范文档

必须完整阅读以下文档

  1. /rules/resource-management-guide.md 资源管理规范
    • 了解资产目录结构与文档放置规则
  2. /rules/documentation-guide.md 文档编写规范
    • 文档格式、命名、结构等要求

步骤 2需求对齐

首次回复必须使用以下模板,等待用户补充信息后再继续:

收到,准备创建文档。

请详细描述您的需求:
- 文档类型(需求文档、设计说明、用户手册等)
- 目标读者
- 主要内容方向

步骤 3文档生成

  • 根据用户需求组织文档结构
  • 参考已有项目文档和数据源补充上下文
  • 输出 Markdown 格式的文档

输出文件

  • src/docs/<doc-name>.md - 文档文件
  • src/docs/assets/ - 文档配图等附属资源(如需要)

参考

rules/resource-management-guide.md | rules/documentation-guide.md