project-documentation-architect
暂无简介
- License 许可
- MIT
- 所属仓库
- poppyTM/oride
- 最近更新
- 2026-09-30
- Stars
- ★ 1
- Forks
- 0
02 资源文件 12
- 参考文档checks/post-flight.md484 B
- 参考文档checks/pre-flight.md477 B
- 参考文档examples/tiny-cli.md376 B
- 参考文档manifest.json2.0 KB
- 参考文档references/bilingual.md639 B
- 参考文档references/modes.md856 B
- 参考文档references/orchestration.md894 B
- 参考文档references/profiles.md1.1 KB
- 脚本scripts/verify.sh1.5 KB
- 参考文档templates/adr.md241 B
- 参考文档templates/microcontext.md225 B
- 参考文档templates/project-docs.json314 B
03 SKILL.md 正文
Project Documentation Architect
Build and maintain implementation-ready, living project documentation —
product, architecture, contracts, evidence, quality gates — in canonical
en-US plus synchronized pt-BR, with the least workforce sufficient.
Portable core: ~/project-documentation-architect/ (agentskills.io format);
this package is the Prumo-native adapter of that core.
Purpose
Turn idea -> context -> requirements -> research -> decisions -> contracts -> documentation -> readiness -> execution -> evidence -> delta -> continuous maintenance, producing a versioned, evidence-backed
documentation system (not a pile of Markdown) that lets future agents work
without rediscovering everything.
Use when
Creating, initializing, bootstrapping, adopting, or formally planning a software project before substantial implementation begins; adopting an existing repo that lacks adequate docs; maintaining docs of an already documented project (delta); or when asked for an implementation bible, living book, full architecture, or agent handoff documentation.
Do not use when
Single-function bug fixes, trivial edits inside an already documented project, explicitly disposable one-off scripts, or pure code review with no documentation mandate. For small changes inside documented projects, run Mode DELTA only.
Required context
- User intent or briefing (GENESIS) or repo snapshot (ADOPTION/DELTA).
- Detected documentation profiles (see
references/profiles.md). docs/project-docs.jsonmanifest when it already exists; create it first when it does not (template:templates/project-docs.json).
Procedure
- Select mode: GENESIS (no trusted docs yet), ADOPTION (repo exists, docs
missing/partial/untrusted — inspect code, tests, CI, config, runtime
first, then write a Gap Matrix and fix only the delta), DELTA (docs exist
— update only impacted capabilities, contracts, tests, docs, risks,
migrations, translations). Detail:
references/modes.md. - Detect profiles and resolve the mandatory contract pack per profile
(
references/profiles.md). Write/updatedocs/project-docs.jsonfirst: identity, profiles, contracts, semantic roles, statuses, owners. - Select the least workforce sufficient (
references/orchestration.md): tiny CLI = orchestrator + architect + one documenter + translator; add product, research, UI/UX, a11y, security, performance, dependency, ADR, traceability, parity-review, audit roles only as profiles demand. Never assign two writers to the same canonical artifact concurrently. - Draft canonical
en-USdocs, then translate impacted pairs topt-BR, then parity-review (references/bilingual.md). Technical errors found during translation are fixed inen-USfirst and re-propagated — never patchpt-BRalone. - Run
scripts/verify.sh, completechecks/post-flight.md, and record a documentation delta (changed capabilities/contracts, impacted docs/tests/translations, severity, requires_review).
Decision rules
- Never invent features, requirements, commands, APIs, benchmarks, files, or decisions. Unknowns become OPEN, ASSUMPTION, RESEARCH REQUIRED, or BLOCKING QUESTION.
- Material claims need
claim -> source -> evidence -> verification -> decision.verified,safe,complete, anddoneare forbidden without verifiable semantics. - Depth follows
complexity + risk + impact + irreversibility. No empty checklist files; group content for simple projects. - Human-approved decisions outrank inference; real behavior + valid tests
- approved contracts outrank unverified assertions.
- Contradictions are preserved as CONTRADICTION records (both claims plus evidence) and resolved via the authority model or the human — never merged silently.
Evidence required
- Automated test runs, build outputs, or verification logs where the skill
touches behavior;
scripts/verify.shoutput for documentation runs. - Every normative MUST links to an acceptance criterion plus a test pointer.
- Required evidence for sign-off:
review(andtestwhen implementation or executable checks are involved).
Output contract
- Updated
docs/project-docs.jsonmanifest. - Canonical
en-USdocuments plus synchronizedpt-BRversions for every required pair (states CURRENT or IN_REVIEW, never silent STALE). - Documentation delta record plus handoff microcontexts (one loadable context per work stream — never a full dump).
- Completed
checks/post-flight.md; residual risks and open questions recorded explicitly.
04 同仓库更多 Skills
zoom-reflow
暂无简介
wireframe-styleguide
暂无简介
visual-regression
Pixel-by-pixel snapshot testing, Playwright integration, dynamic content masking, deterministic font rendering, and cross-browser CI gates
ui-implementation
Component-driven UI implementation, multi-state matrix (default, hover, focus-visible, active, disabled, loading, empty, error), DTCG design tokens, responsive layout contracts, and accessibility tree mapping.
tui-editor-engine
Text buffer and editing semantics for a terminal code editor — index conversion, transaction-first editing, multi-cursor invariants, undo grouping, and large-file behaviour.
tree-sitter-context-indexing
暂无简介