agentleFS
JunfengRanJunfengRan/dev-env/skills/write-idea-docs/SKILL.md

write-idea-docs

Skill1 starsChanged 3 months agoMITView on GitHub

在 dev-env 撰写或修订开源设计文档(架构 / 技术栈 / 工作流 / 选型决策)。 触发:用户要求写架构设计、技术栈总览、方案取舍、选型决策; 新建或修改 docs/design/ 下 *-architecture.md、*-tech-stack.md、*-workflow.md、*-selection.md。

The file

Files
SKILL.md

设计文档写作

将产品/系统想法写成 可评审、可落地、可横向对比 的设计文档。

文档类型与命名

类型文件名模式输出目录
架构{topic}-architecture.mddocs/design/
技术栈{topic}-tech-stack.mddocs/design/
工作流{topic}-workflow.mddocs/design/
选型决策{topic}-selection.mddocs/design/

统一工作流

1. 定类型与命名 → 2. 写 metadata → 3. 列大纲 → 4. 写核心 Idea
→ 5. 方案取舍表 → 6. 架构图 → 7. 交叉链接 → 8. 验证

选型决策文档必须含:选型前提、竞品对比、编号 catalog(XX-NN)、优先级表(P0–P3)。

模板见 references/architecture-template.md、references/tech-stack-template.md。

验证

  • Mermaid → npm run validate:mermaid
  • 深度 → references/depth-checklist.md
  • deep-research decide 阶段 → gate decision-doc-complete

协作

  • 意图/方案未对齐时 → 可选 brainstorm(启发式,非必经)
  • 画图 → draw-mermaid-diagrams
  • 由 deep-research workflow 的 decide 状态调用

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.