Documentation Writing Skill

Automate traceable documentation from requirements to executable BDD tests.

Updated May 27, 2026
One-click install
npx skills add https://github.com/ormastes/Spipe --skill documentation-writing-skill
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: Documentation Writing Skill
Source: https://github.com/ormastes/Spipe/tree/main/doc/00_llm_process/skill_command/skills/claude/lib/doc
Command: npx skills add https://github.com/ormastes/Spipe --skill documentation-writing-skill

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps you organize documentation into a traceable workflow so designs and requirements lead directly to executable BDD tests, reducing ambiguity and rework.

Core Features & Use Cases

  • Document relationship model: Guides you from PLAN and REQUIREMENTS through FEATURE SPEC and into BDD TESTS and TEST RESULTS.
  • Clear document types and locations: Enforces where each artifact belongs (research, requirements, NFR/SLO, architecture, ADR, design, spec, guides, tracking, reports).
  • Workflow for new features: Provides an end-to-end drafting sequence that keeps architecture decisions and implementation details aligned with testing.
  • Writing and governance rules: Requires executable specs in test/ using *_spec.spl and discourages writing spec.md, while prescribing formatting standards for research/design documents.

Quick Start

Use the Documentation Writing Skill to produce a complete feature documentation set where requirements and design are explicitly linked to *_spec.spl BDD tests for a new feature.

Frequently Asked Questions about Documentation Writing Skill

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

FAQPage Schema
How do I turn requirements into executable BDD tests?

Executable BDD tests are produced by defining a strict artifact taxonomy and workflow that links requirements and design directly to executable `*_spec.spl` tests. This workflow reduces ambiguity by ensuring feature specs explicitly reference testing scenarios.

What is the workflow for software documentation in new feature planning?

The software documentation workflow guides you from PLAN and REQUIREMENTS through FEATURE SPEC and into BDD TESTS and TEST RESULTS. It provides an end-to-end drafting sequence aligning architecture decisions and implementation details with testing.

Where should architecture decisions and requirement documents be placed in the repository?

Architecture decisions and requirement documents must be placed in specific repository locations defined by a strict artifact taxonomy. The Skill enforces where artifacts like research, NFR/SLO, architecture, ADR, design, spec, guides, tracking, and reports belong.

Do I need to write spec.md for feature specifications?

Writing `spec.md` is discouraged for feature specifications. You must adopt executable specs placed under the `test/` directory using the `*_spec.spl` format to ensure specifications are testable and traceable to requirements.

How does capturing architecture decisions work with this documentation workflow?

Architecture decision capture works by integrating ADRs into the document relationship model, linking them directly to feature specs and executable BDD tests. This ensures governance rules and design specifications remain aligned with testing scenarios throughout the workflow.

What formatting standards are required for research and design documents?

Research and design documents must adhere to prescribed formatting and writing standards defined by the artifact taxonomy. These governance rules ensure traceability across the workflow from initial research through to executable BDD test scenarios.