spec

Engineering Community

Skill notes

Step 1: Read the Requirements

Before writing, gather the inputs. A spec without requirements is guesswork. Source · What to pull from it PRD · Problem, goals, functional requirements, non-functional requirements, scope boundaries Job stories · User workflows, acceptance criteria, edge cases Conversation · If neither exists, interview the user to establish what the system must do and for whom

Step 2: Write the Spec

Use this structure. Adapt headings to the project — not every section applies every time.

Decision Log

Every non-obvious choice gets logged. This prevents re-litigating decisions later and helps future engineers understand why things are the way they are. Keep decisions numbered (D-1, D-2) so they can be referenced in code comments and PR descriptions.

Quality Checks

Before delivering the spec, verify: Does it answer "how" without dictating unnecessary "what exactly"? The spec should constrain the architecture, not micromanage the implementation. Engineers need room to make local decisions. Are edge cases covered? If you only describe the happy path, the implementation will only handle the happy path. Is the data model complete? Missing a field or relationship here means a migration later.

Scope Boundaries

A tech spec is not: A tutorial. Don't explain how frameworks work. Assume engineering competence. A PRD. Don't redefine what we're building. Reference the PRD and focus on how. A project plan. Don't include timelines or task assignments. That's a separate artifact.

Fluxly profile Runtime and permissions are inferred by Fluxly static checks, not author declarations or runtime test results.
Domain
Engineering
Author-declared agents
No explicit declaration found; this is not inferred or tested compatibility
Static check
94 / 100 · heuristic scan, not runtime safety proof
Runtime evidence
Not run; no isolated runtime test evidence is currently recorded
Author / version / license
@kazdenc · MIT
Token usage
Lean
Setup complexity
Guided setup
External API key
Not required
Operating systems
Unspecified (assume cross-platform)
Runtime requirements
No explicit requirements detected
Detected file/system behavior
  • Read-only
  • Write / modify
  • Shell exec
Network behavior
Local-only
Install commands
None (reference only)

Heads up: Tool permissions are not declared; actual access depends on the runtime.

01
Step 1: Read the Requirements

Before writing, gather the inputs. A spec without requirements is guesswork. Source · What to pull from it PRD · Problem, goals, functional requirements, non-functional requirements, scope boundaries Job stories · User workflows, acceptance criteria, edge cases Conversation · If neither exists, interview the user to establish what the system must do and for whom

02
Step 2: Write the Spec

Use this structure. Adapt headings to the project — not every section applies every time.

Discussion

Powered by GitHub Discussions. Sign in with GitHub to comment, react, or subscribe.