Skip to content

About

Feature Requirement Docs as a way to manage Agentic Coding

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Latest commit

 

History

10 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FRED = Feature Requirement Documents

Works with Cursor, Claude Code, and Codex via the skills CLI.

You describe what you want in plain language. An agent turns that into a scoped FRED and implements from that file. A roadmap groups implementation into tracks; operations checklists capture setup and shared UX verification. Independent review can use a separate, more capable model when useful. All of it lives in the repo, next to the code.

Linear, Notion, and Jira can still exist. For this slice of planning they are optional sources you cite as “derived from.” The documents the agent maintains and implements from are in git.

This package is methodology plus generators. It does not encode a product, cloud vendor, or app stack. The consuming project’s own agent entrypoint is the contract.

At a glance

FRED is a repo-native workflow: one implementation slice per file, stable IDs and paths, parallel tracks, and explicit verification evidence. Its lifecycle is Draft → Open → Implemented → Closed. Implementation can finish while external setup or a combined deployed journey remains pending.

The workflow

  1. Specify. Define scoped behavior, contracts, non-goals, and proportionate implementation criteria. Create applicable delivery tasks at this stage.
  2. Schedule. Group ordered slices by outcome and ownership in ROADMAP. Agreed contracts and named fakes can enable parallel work; record integration ownership. Implementation prerequisites govern readiness, not numeric IDs.
  3. Implement and check. Complete the behavior, local verification, and affected documentation. Run the project's global lint/format check from its documented working directory, including cascading monorepo module checks. A module-only pass is insufficient. Record the actual results before review handoff or marking Implemented.
  4. Review when appropriate. A separate reviewer checks the contract, code, and evidence. Required corrections reopen work; optional suggestions do not expand acceptance. The project can require review for consequential changes.
  5. Verify delivery and close. An operator or equipped agent executes linked setup/flow tasks. Record target, revision/deployment, and evidence, and run the global check again before Closed sign-off. Preview is distinct from production; libraries/tooling use relevant integration evidence.

Missing, blocked, or failing global checks block sign-off. Rerun after changes to check inputs. Behavioral checks still matter: after the global check, run additional QA (including browser or render inspection when relevant) only when the FRED's verification criteria call for it; backend slices require appropriate rule, authorization, persistence, and integration checks when those criteria apply. Shared deployed journeys and third-party setup live separately so correct implementation can progress. Planning-only Draft → Open does not require executing code checks.

How it works in a project

docs/
├── agent-guides/00-AGENT-ENTRYPOINT.md   # workflow, commands, guide pointers
└── features/
    ├── ROADMAP.md                        # IDs, ordered tracks, claims, next actions
    ├── OPERATIONS.md                     # setup and shared delivery-flow evidence
    ├── template.md                       # lean slice skeleton
    └── NNN-kebab-slug.md                 # stable path in every lifecycle state
  • Entrypoint and procedure guides own project workflow and repeatable CI, database, and preview procedures. Load the relevant guide when needed.
  • Architecture owns durable boundaries and contracts. Update existing docs when implementation changes them; avoid duplicating code/generated schemas.
  • FREDs own slice requirements, authoritative lifecycle state, and local evidence. ROADMAP summarizes them and schedules work.
  • OPERATIONS owns outstanding setup and combined UX verification. One flow may cover several FREDs; keep secrets out of documentation and evidence.
  • Code establishes runtime facts. Resolve discrepancies with requirements and architecture explicitly.

Readiness and blockers are roadmap fields, not extra lifecycle states. Each Implemented slice has a date and a next action or pending gate. Tracks do not authorize delegation, Git actions, or deployments.

This skill's templates are seeds. Existing project documents govern the repo. Architecture and CI/database/preview guides are added only when useful; link existing documentation and maintained scripts instead of creating duplicates.

The entrypoint's routing table names when to read each source, its relevant section, and what it owns. Read source contracts rather than treating summaries as authority. When work stops unfinished, leave concise resume notes in the FRED and update the roadmap claim/next action. The next session compares those notes with the actual checkout and relevant environment before continuing.

Changes to acceptance, verification scripts, or CI/global-check coverage need a recorded rationale and review alongside the implementation. Do not weaken verification merely to obtain a pass.

Skills in this package

Skill Use it for Output
create-fred Gather requirements, research relevant contracts, ask focused questions, create/refine a slice Draft/Open FRED, roadmap row, applicable operation items
implement-fred Implement a named FRED or pick the next ready slice in the requested/active track Implemented slice with check evidence, or explicit blocker/resume notes
fred Bootstrap, migration, track coordination, and methodology/workflow review Project contract and maintained framework documents

For the usual workflow, alternate between create-fred and implement-fred. Creation is conversational but does not require an interview for a clear request. Implementation normally completes one agreed slice and ends at Implemented; combined deployed flows remain explicit in OPERATIONS. The roadmap can designate an active/focus track. A blocked selected track is reported rather than silently replaced by another track.

All three skills read project documents as authority. The task skills do not depend on sibling files surviving selective installation. fred can still support ordinary slice work when installed alone or explicitly invoked. Skill selection does not automatically change model or launch an independent agent.

Add further companions only when a distinct workflow repeatedly benefits from its own invocation and judgment. Guides own project facts/procedures; scripts handle repeated mechanics; skills write results into existing documents. Independent FRED review is a potential further reusable companion. Delivery-flow execution, CI diagnosis, and database evidence collection are better project-local candidates when they need environment-specific guidance. Those further candidates are proposals, not packaged skills. Do not generate a project skill suite or one skill per lifecycle stage by default.

Companions can be manually invoked using the host's supported policy. Keep ordinary FRED discovery available, avoid automatic chaining of manual-only skills, and preserve the global check requirement. See the companion evaluation for selection, placement, inputs/results, and host-specific invocation settings.

When to use

  • You are building or planning software in a repository and want features as versioned docs an agent can follow.
  • You want to add a feature, ask what to implement next, or turn a messy idea into a FRED.
  • You want teammates (human or agent) to coordinate implementation tracks without a board as the source of truth.

When not to

  • The chat is not about the software you are implementing: product features of some other site, a design critique of a public app, or general product-strategy talk with no repo work.
  • The repo already has a different spec system you intend to keep. Ask before generating a parallel docs/features/ tree.
  • You need a project tracker for people, deadlines, and stakeholders. Keep that. Point FREDs at it with “derived from”; do not replace it unless you want to.

Install

skills.sh / Skills CLI:

npx skills add ramidecodes/fred-skill

Same source, full GitHub URL, skill named fred only:

npx skills add https://github.com/ramidecodes/fred-skill --skill fred

Select the three packaged skills explicitly:

npx skills add ramidecodes/fred-skill --skill fred --skill create-fred --skill implement-fred

Global (user-level, all projects):

npx skills add -g ramidecodes/fred-skill

From a local clone:

npx skills add /path/to/fred-skill

Install/update all three globally from the current checkout:

npx skills add . -g --skill fred --skill create-fred --skill implement-fred

Default installation is project-local; -g selects global installation. The CLI discovers each skills/<name>/SKILL.md. See the Skills CLI documentation for agent selection and other installation options.

The skills support manual invocation and normal automatic discovery through their distinct descriptions; host behavior varies. Pair installation with a pointer so teammates without the skills still get the project contract:

Agent contract: read docs/agent-guides/00-AGENT-ENTRYPOINT.md at session start.

Bootstrap vs existing docs

When FRED documentation is absent, bootstrap creates the entrypoint, FRED template, ROADMAP, and OPERATIONS, filling placeholders from this repository. The entrypoint records the actual global check command and working directory. Request bootstrap explicitly, or accept the agent's offer.

Existing project contracts remain authoritative. Legacy open indexes and state folders are migrated only when requested, preserving IDs, scope, history, and actual verification evidence. An old Implemented label alone does not prove deployed closure.

Typical prompts

$create-fred Users can invite people by email. Help define a slice and its checks.

$implement-fred Implement the next ready FRED in the active track.

$create-fred Refine our export-to-CSV Draft. Keep it a slice, not the reporting suite.

$fred Bootstrap FRED docs in this repo from the skill templates.

$implement-fred Implement FRED 012. Run the global check before handoff.

Review this Implemented FRED against its code and evidence. Separate required fixes from suggestions.

$fred Migrate our index to tracks and collect pending setup/UX checks in OPERATIONS.

For humans vs for agents

  • This README is the idea: why FRED, how implementation and delivery verification fit together, how to install.
  • skills/fred/SKILL.md owns methodology, bootstrap, migration, and coordination.
  • skills/create-fred/SKILL.md guides requirement gathering and specification.
  • skills/implement-fred/SKILL.md guides work selection, implementation, and verification.
  • skills/fred/references/ is detail (methodology, workflow, bootstrap) loaded when needed.
  • skills/fred/templates/ is what gets copied into a consuming repo, then edited there.

License

Apache-2.0. See LICENSE.

About

Feature Requirement Docs as a way to manage Agentic Coding

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors