j.doc

Generates complete Markdown documentation files from resolved path objectives and scrum-board evidence.

Updated Aug 3, 2026
One-click install
npx skills add https://github.com/samwelmunga/jenga-npm --skill j-doc-samwelmunga
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: j.doc
Source: https://github.com/samwelmunga/jenga-npm/tree/main/.agents/skills/j-doc
Command: npx skills add https://github.com/samwelmunga/jenga-npm --skill j-doc-samwelmunga

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and assets (resource) components.

What problem does it solve? Keeping project documentation accurate is hard when READMEs, API references, and changelogs drift out of sync with actual code and completed work. This Skill regenerates entire documentation files from a resolved objective and gathered evidence, replacing stale content in one authoritative write. ## Core Features & Use Cases - Objective-driven generation: Resolves a target path (README.md, docs/API.md, docs/CLI.md, docs/CONTRIBUTING.md, CHANGELOG.md, docs/STRATEGY.md) to a documented objective with required sections via a YAML rule table, and stops to ask when the target is unknown. - Evidence-based synthesis: Builds a synthesis context from user instructions, scrum-board items, codebase evidence, and git history, while preserving still-valid maintainer intent from the existing file. - Provenance tracking: Runs a resolver script that scans board epics, stories, and tasks for docs annotations to derive a last_update frontmatter date, falling back to unknown when no provenance exists. - Use Case: After a sprint completes, run /doc to regenerate the project README with current features and getting-started steps, or /doc docs/API.md to rebuild the API reference grounded in real endpoints. ## Quick Start Ask the agent to run /doc with no arguments to regenerate the project README, or provide a target path such as /doc docs/API.md to regenerate that specific document.

Frequently Asked Questions about j.doc

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I regenerate a project README automatically?▼

Invoke /doc with no arguments to target the default README.md path. The skill resolves the project-overview objective, gathers evidence from the codebase and scrum board, and writes a full replacement README with Description and Getting Started sections.

How do I generate API reference documentation from my codebase?▼

Run /doc docs/API.md to resolve the API reference objective. The generated document groups content by module or route family and documents signatures, parameters, return values, and errors grounded in actual code and board evidence.

What happens when the documentation target path is unknown?▼

The skill stops and asks exactly what the target path should document instead of guessing. Once you describe the objective, it surfaces the resolved contract and continues with generation.

How does last_update provenance work in generated docs?▼

A Python resolver scans board epics, stories, and tasks for completed items whose docs annotation exactly matches the target path. The most recent date_completed becomes last_update; if none match, the frontmatter emits unknown.

Does regenerating a document lose existing maintainer notes?▼

The skill reads the existing target file first and extracts still-valid maintainer intent such as warnings, caveats, and terminology preferences into the synthesis context. Stale factual claims that conflict with new evidence are not carried forward.

Why is the Examples section missing from my generated README?▼

The Examples section is only included when the project type (CLI, API, or library) can be confidently inferred from evidence and at least two grounded examples exist. Otherwise the section is omitted rather than filled with placeholder content.