Agent skills for documenting and maintaining software projects with business context first.
These skills are designed to be small, practical, and easy to adapt. They encode repeatable workflows for agents so project knowledge stays readable for humans and useful for future LLM sessions.
Install from GitHub with the skills installer:
npx skills@latest add EaeDave/skillsOr with Bun:
bunx skills@latest add EaeDave/skillsPick the skills you want to install and the coding agents you want to use them with.
For local development, from this repository:
bunx skills@latest add .Most project documentation starts with commands, frameworks, and setup details. Those are useful, but they are not the hardest thing for humans or agents to recover later.
The hard part is usually the business behavior:
- what the system does for users;
- which rules drive decisions;
- which states, validations, and exceptions matter;
- where the implementation proves those rules;
- what future agents need to know before changing behavior.
These skills keep that context close to the code, explicit, and maintainable.
- clean-code-for-agents — Applies a Clean Code discipline tuned for AI agents, follows an XP/TDD loop, and installs persistent
AGENTS.md/CLAUDE.mdrules from a marker-delimited template.
- business-readme — Identifies business rules from project context and maintains a concise
README.mdwith human-readable rules first, including labeled internal endpoints and external APIs/operations when relevant. Also maintainsdocs/LLM_CONTEXT.mdfor future agents. User-invoked only. - work-report — Generates concise Markdown work reports for Jira, Linear, or similar cards from the current session, relevant code changes, and related commits.
- visual-report — Generates stakeholder-facing, self-contained HTML reports with Mermaid diagrams for comparing business rules, mapping project context, and visualizing flows or timelines. User-invoked only.
skills/
business-readme/
SKILL.md
scripts/
validate-business-readme.cjs
clean-code-for-agents/
SKILL.md
assets/
agent-rules.md
clean-code-for-agents.skill
work-report/
SKILL.md
visual-report/
SKILL.md
assets/
base.html
templates/
comparison.md
context-map.md
flow.md
timeline.mdEach skill lives in its own directory and includes a SKILL.md file with frontmatter:
---
name: skill-name
description: Use when...
---
Skill instructions here.After installing, invoke the skill explicitly (e.g. /business-readme) when you want to create or refresh project documentation from actual project context. The agent will not trigger it on its own.
The skill will:
- ask which language the docs should use;
- inspect relevant project sources;
- update
README.mdwith business rules before technical instructions; - create or update
docs/LLM_CONTEXT.mdwith current implementation context, labeled internal/external endpoints and operations, uncertainties, and durable gotchas; - validate the generated documentation when the validator script is available.
Validator command:
node business-readme/scripts/validate-business-readme.cjs <project-root>After installing, run the skill when you need a concise Markdown delivery report file for a card or ticket.
The skill will:
- use the current conversation as the primary scope;
- collect Git context from status, diffs, branch commits, and recent commits;
- ask before including ambiguous commits;
- create a natural root-level Markdown report file with context, completed work, business rules, related commits, validation, and observations.
Add new skills by creating another directory with a SKILL.md file:
new-skill-name/
SKILL.mdThen test the repository locally:
bunx skills@latest add .Review every skill before installing or running it. Agent skills execute with the permissions of the agent using them, so instructions should stay explicit, auditable, and scoped to the intended workflow.