Architecture doc
Skill firefly-events/plugin-hive/skills/hive/skills/architecture-doc
Author a technical design / architecture document — context, proposed design, alternatives, risks. Use when a non-trivial change or system needs a written design before implementation.From its SKILL.md
npx -y skills add firefly-events/plugin-hive --skill architecture-docAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
2 things to look at
- no licenseNo license file was found in the repository. Code published without one is not open source by default, so using it at work is a question for whoever answers licensing questions where you are.
- 2 stars2 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
SKILL.md
2.6 KB, as published. Nobody here has run it
Hive Architecture Doc
Produce a technical design document that lets a reviewer understand the shape of a solution — and the reasoning behind it — without reading code. The document covers the problem, the proposed design, the alternatives weighed, and the consequences.
Input: $ARGUMENTS (or upstream architect/researcher findings) describing
the problem, goals, constraints, and any candidate approaches.
When to use
- A feature or system is large or risky enough to warrant design-before-build.
- Multiple approaches exist and the choice needs to be justified and recorded.
- Cross-component or cross-team work needs a shared reference.
For a single discrete decision with alternatives, prefer adr (lighter weight).
For a per-story unit of work, use story-writing.
Sections (produce in this order)
- Title & status — what is being designed; status (draft / under review / accepted).
- Context & goals — the problem, the forces (constraints, requirements, deadlines), and explicit goals.
- Non-goals — what this design intentionally does not address. Bounds the scope.
- Proposed design — the recommended approach. Describe components, responsibilities, and how they interact. Include a data/flow sketch (text or Mermaid) when it aids clarity.
- Alternatives considered — each rejected option with a one-line why not. Shows the decision was reasoned, not defaulted.
- Risks & trade-offs — what could go wrong, what gets harder, mitigations.
- Rollout / migration — how it ships: phases, flags, backfill, reversibility. "Big bang" only if justified.
- Open questions — unresolved items needing a decision, or "none".
Tone & style
- Audience is an engineer reviewing the approach. Precise, justified, no marketing.
- Every significant choice carries a why. Assertions without rationale are gaps.
- Diagrams as Mermaid fenced blocks; keep them small and legible.
Output
One design document per task. Default path: as named in the task; if unspecified,
.pHive/epics/{epic-id}/docs/architecture.md.
What this skill is NOT
- Not an ADR. ADRs record one decision; this documents a whole design. If the input is a single choice with alternatives, use
adr. - Not implementation. Describe structure and rationale, not line-level code.
- Not a story. Acceptance criteria belong in
story-writing.