shipping-artifacts

Solid

Documenting an AI-built app for handoff, review or audit: the docs that make it reviewable (architecture, flows, permissions, variables, coverage).

AI & Automation 633 stars 85 forks Updated today MIT

Install

View on GitHub

Quality Score: 91/100

Stars 20%
93
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# Shipping Artifacts: The Docs That Make AI-Built Code Reviewable ## Purpose **Keep a durable record of intent so the code can be reviewed.** Record what the system should do, who may do what, where secrets live, and which rules are actually verified. Without that record, neither a human nor an auditing agent can tell whether AI-built code is safe to ship. This skill defines the small document set that restores reviewability. **Write the intended-state record for humans and the next coding agent.** Every later audit compares code against these docs. A security or performance review is only as good as the intent it can compare against. ## Locations and names: the repo's setup wins **Treat this plugin's locations, file names, and doc formats as defaults.** The host repo's own setup comes first. Before writing any system doc, coverage map, or audit report, look for: 1. Agent instructions — `AGENTS.md`, `CLAUDE.md`, and everything they import or point to. They often name the docs folder, its files, who maintains each one, and how dates are recorded. 2. A docs location — an existing `docs/`, `documentation/`, or similar folder. 3. Existing equivalents — documents covering the same subjects, under any name: `ARCHITECTURE.md`, `docs/security.md`, `docs/env.md`. Match on coverage, not file name. 4. An existing test-coverage map — a file mapping behaviour to its tests, such as `docs/test-coverage.md`. Match on coverage: a `TESTS.md` or `testing.md` describing how the repo tests ...

Details

Author
phuryn
Repository
phuryn/product-engineering
Created
2 weeks ago
Last Updated
today
Language
Python
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category

Data & Documents Featured

document-app

'Document the app': write or refresh an app's system docs from its code. 'Are the docs right?': check mode, which only reports where docs and code disagree.

633 Updated today
phuryn
AI & Automation Listed

pm-ai-ship-audit

AI 生成代码的上线前审计技能(vibe-coded app 交付审计)。两个方法 + 五条流程: 「文档基线」(架构、用户与权限流、权限矩阵、变量与密钥、测试覆盖地图,外加邮件/定时任务/SEO/内嵌 Agent 四个条件文档)、 「意图 vs 实现」(找文档写了但代码没做到的差距——通用扫描器发现不了的那一类 bug); 流程含反向补文档、推导测试覆盖、静态安全审计、静态性能审计(专抓 N+1 与请求瀑布)、上线检查总装。 能力:(1) 给 AI 写出来的代码补齐可评审的文档基线 (2) 交叉核对文档意图与代码实现的差距 (3) 出带证据行(file:line + 原文片段)且经过自我反驳的审计报告。 触发词:「上线前检查」「AI 代码审计」「vibe coding 检查」「代码和文档对不上」「权限有没有漏」 「安全审计」「性能审计」「N+1」「请求瀑布」「补系统文档」「测试覆盖地图」「ship check」, 或者用户说「这个项目是 AI 写的,能上线吗」时。 不适用:常规代码评审 → /code-review(Claude Code 内置,Codex/Cursor 无此技能);架构与详细设计文档 → hld-design / lld-design; 测试用例设计 → pm-test-cases;系统性排障 → systematic-debugging。 参考文档为英文原文,产出语言跟随用户提问语言。

1 Updated 2 months ago
iDWong
Code & Development Listed

pm-ai-ship-audit

AI 生成代码的上线前审计技能(vibe-coded app 交付审计)。两个方法 + 五条流程: 「文档基线」(架构、用户与权限流、权限矩阵、变量与密钥、测试覆盖地图,外加邮件/定时任务/SEO/内嵌 Agent 四个条件文档)、 「意图 vs 实现」(找文档写了但代码没做到的差距——通用扫描器发现不了的那一类 bug); 流程含反向补文档、推导测试覆盖、静态安全审计、静态性能审计(专抓 N+1 与请求瀑布)、上线检查总装。 能力:(1) 给 AI 写出来的代码补齐可评审的文档基线 (2) 交叉核对文档意图与代码实现的差距 (3) 出带证据行(file:line + 原文片段)且经过自我反驳的审计报告。 触发词:「上线前检查」「AI 代码审计」「vibe coding 检查」「代码和文档对不上」「权限有没有漏」 「安全审计」「性能审计」「N+1」「请求瀑布」「补系统文档」「测试覆盖地图」「ship check」, 或者用户说「这个项目是 AI 写的,能上线吗」时。 不适用:常规代码评审 → /code-review(Claude Code 内置,Codex/Cursor 无此技能);架构与详细设计文档 → hld-design / lld-design; 测试用例设计 → pm-test-cases;系统性排障 → systematic-debugging。 参考文档为英文原文,产出语言跟随用户提问语言。

1 Updated 2 months ago
iDWong