elegant-delivery-docs
Skill1 starsChanged 10 days agoMITView on GitHub
Produces magazine-grade, crystal-clear delivery summaries in chat and automatically generates standalone Markdown architecture/wiring guides for new modules or cross-file refactors.
In this repository45 other files it gives its agents.
- ask-mattSkill
- audit-context-buildingSkill
- codebase-designSkill
- code-eleganceSkill
- code-reviewSkill
- diagnosing-bugsSkill
- differential-reviewSkill
- dispatching-parallel-agentsSkill
- domain-modelingSkill
- grill-meSkill
- grill-with-docsSkill
- handoffSkill
- impeccableSkill
- implementSkill
- implement-specSkill
- improve-codebase-architectureSkill
- karpathy-guidelinesSkill
- mcp-builderSkill
- ponytail-auditSkill
- ponytail-debtSkill
- ponytail-gainSkill
- ponytail-helpSkill
- ponytail-reviewSkill
- ponytailSkill
- postgres-best-practicesSkill
- prior-art-researchSkill
- prototypeSkill
- prSkill
- react-best-practicesSkill
- receiving-code-reviewSkill
- researchSkill
- retroSkill
- ruflo-swarm-sparcSkill
- scrapling-officialSkill
- setup-matt-pocock-skillsSkill
- setup-pre-commitSkill
- subagent-prompt-architectureSkill
- tddSkill
- to-specSkill
- to-ticketsSkill
- triageSkill
- using-git-worktreesSkill
- verification-before-completionSkill
- wayfinderSkill
- webapp-testingSkill
The file
Files
/elegant-delivery-docs — 优雅交付简报与架构接线文档规范(3A 标准)
工作完成后的交付呈现直接决定用户的使用体验。无论是聊天窗里的完工简报,还是落盘的 .md 工程指南,都必须做到结论先行、脉络可视、拿来即用、后路清晰。
一、 聊天窗完工交付卡标准结构(所有任务标配)
每次任务完工后,主理官在聊天窗输出的最终交付报告必须采用以下清晰、优雅的排版结构(根据任务体量自适应详略):
## ✅ 本次完成(一句话核心成果)
直白交代完成了什么目标、当前运行/测试状态如何、带来了什么可量化的收益。
### 1. 核心改动与优雅设计取舍
| 模块 / 文件 | 核心改动内容 | 为什么这样设计(优雅度与安全性考量) |
| :--- | :--- | :--- |
| `path/to/file` | 简明职责与变更 | 说明背后的工程取舍(如:边界一次性归一化、表驱动解耦、零外部依赖等) |
### 2. 整体接线与数据流脉络(跨函数 / 跨文件任务标配)
用 5~10 行干净利落的 **ASCII 架构接线微图** 直观展示模块间的调用关系与数据流向:
`[输入/触发入口] ──► [边界归一化层] ──► [核心深模块] ──► [持久化/输出]`
### 3. 实测验证证据(真跑实测,零推断)
- 实际执行的测试套件、构建检查、真实数据抽样结果或性能前后对比数据。
### 4. 快速使用口令 & 安全后路
- **怎么用**:用户立即可用的命令、配置入口或验证操作。
- **怎么退(安全后路)**:备份路径或一行命令无损回滚方案。二、 中大型任务自动沉淀独立 .md 指南(3A 自动触发规则)
当任务属于 新模块/新插件开发、跨文件架构/存储改造、或可复用的方法沉淀 时(无需等用户手动要求“总结成 .md”),自动在项目合适文档目录生成一份高水准 .md 架构/使用指南,包含:
- 组件全景与 ASCII 接线图(Wiring Diagram):30 秒看懂涉及哪些文件、各司何职、如何衔接。
- 最小可复制模板(Copy-Paste Ready Template):提炼出干净、带关键注释的最小可用代码模板,方便未来直接复用。
- 关键数据流与接口锚点表(File:Line Reference):精确列出核心函数、文件路径、输入输出契约。
- 设计约束与避坑备忘录(Pitfalls & Gotchas):记录关键边界条件、为什么不采用某错误写法,防止日后维护踩坑。
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
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.

