agentic-doc-ingest
Skill321 starsChanged 54 days agoApache-2.0View on GitHub
Turn the charter, decision log and unit records of a completed feature into documentation — user-facing guides or technical notes — without reading the implementation. Use when a feature built through the agentic development pipeline is finished and needs documenting, when the user says "document that feature", "update the docs for X", or "what did we actually ship". Runs downstream of and independently from the pipeline, so it can be re-run months later.
In this repository92 other files it gives its agents.
- AGENTS.mdAGENTS.md
- apps/AGENTS.mdAGENTS.md
- packages/AGENTS.mdAGENTS.md
- apps/CLAUDE.mdCLAUDE.md
- CLAUDE.mdCLAUDE.md
- packages/CLAUDE.mdCLAUDE.md
- .cursor/rules/packmind/standard-backend-tests-redaction.mdcCursor rule
- .cursor/rules/packmind/standard-changelog.mdcCursor rule
- .cursor/rules/packmind/standard-code-comments.mdcCursor rule
- .cursor/rules/packmind/standard-compliance-logging-personal-information.mdcCursor rule
- .cursor/rules/packmind/standard-typescript-good-practices.mdcCursor rule
- agent-skill-frontmatter-auditSkill
- amplitude-listener-events-adoptionSkill
- cli-e2e-test-authoringSkill
- datadog-analysisSkill
- doc-auditSkill
- feature-specSkill
- feature-sprintSkill
- packmind-onboardSkill
- packmind-update-playbookSkill
- playbook-cli-auditSkill
- product-mapSkill
- qa-reviewSkill
- release-proprietarySkill
- upgrade-runtime-stackSkill
- working-with-playground-appSkill
- working-with-pm-design-kitSkill
- agentic-design-sessionSkill
- agentic-feature-framingSkill
- agentic-orchestratorSkill
- agent-skill-frontmatter-auditSkill
- amplitude-listener-events-adoptionSkill
- cli-e2e-test-authoringSkill
- create-run-e2e-testsSkill
- creating-end-user-documentation-for-packmindSkill
- datadog-analysisSkill
- doc-auditSkill
- feature-flags-auditSkill
- feature-flags-authoringSkill
- feature-specSkill
- feature-sprintSkill
- how-to-write-typeorm-migrations-in-packmindSkill
- improve-claude-mdSkill
- packmind-onboardSkill
- packmind-update-playbookSkill
- playbook-cli-auditSkill
- product-mapSkill
- qa-reviewSkill
- release-proprietarySkill
- upgrade-runtime-stackSkill
- working-with-playground-appSkill
- working-with-pm-design-kitSkill
- agent-skill-frontmatter-auditSkill
- amplitude-listener-events-adoptionSkill
- cli-e2e-test-authoringSkill
- creating-end-user-documentation-for-packmindSkill
- datadog-analysisSkill
- doc-auditSkill
- feature-flags-auditSkill
- feature-flags-authoringSkill
- The first 60 shown.
The file
We split this skill into the rules it gives an agent
3 rules. About 0 are common, 2 are distinctive, and 1 is very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈2
Distinctive · estimate
This author's own choices. Worth a look.
1
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 23
Read a source file only to check a specific name or signature you are about to print.
- Very specific: line 51
Before you finish, verify: every entry marked user-visible: yes, in both the charter and the decision log, has a corresponding mention in …
- Distinctive: line 60
Write the files. Do not commit them.
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Documentation ingest
You write documentation from three files and no code:
.claude/features/<slug>/charter.md what was meant to be built, and for whom
.claude/features/<slug>/decisions.md what was decided, and what was rejected
.claude/features/<slug>/records.jsonl what each unit actually didWhy you do not read the code
Because you do not have to, and that is deliberate. The records carry
public_surface_changed and behaviour_delta on every unit — the executor
filled them in while it still had the change in front of it, which is the
cheapest and most accurate moment that information exists.
Read a source file only to check a specific name or signature you are about to print. Not to survey, not to "understand the feature".
Why the decision log alone is not enough
The decision log records intent. Documentation built from it describes what was meant, not what was built.
The deviations field across the records is exactly that gap. Read it early —
where a unit deviated, the log is wrong and the record is right, and a document
that follows the log will confidently describe something that does not exist.
The two documents are not the same document
Decide which you were asked for; do not blend them.
User-facing. Driven by acceptance criteria marked user-visible: yes and
decisions marked user-visible: yes. Task-oriented, no implementation detail.
For Packmind this lands in apps/doc/ — hand off to the
creating-end-user-documentation-for-packmind skill for house style and
placement rather than inventing your own.
Technical. Driven by public_surface_changed across the records, plus the
decisions and their rejected alternatives. Rationale is already written in the
decision log — link to it, do not paraphrase it into prose that will drift.
The coverage check
Before you finish, verify: every entry marked user-visible: yes, in both the
charter and the decision log, has a corresponding mention in what you wrote.
List the ones that do not, and say why you left them out. This cannot tell you the documentation is good — nothing mechanical can — but omission is the common failure and this catches it.
Output
Write the files. Do not commit them.
This pass has a weak exit criterion by nature, and auto-committed prose from a weakly-gated pass is how documentation quietly becomes wrong. Leave the diff in the working tree, say what you wrote and what the coverage check found, and let the human read it.
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.

