writing-requirements-documents

Generate Obsidian requirements documents with block anchors and validated wiki links.

Updated Oct 25, 2025
One-click install
npx skills add https://github.com/WesleyMFrederick/cc-workflows --skill writing-requirements-documents
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: writing-requirements-documents
Source: https://github.com/WesleyMFrederick/cc-workflows/tree/main/.claude/skills/writing-requirements-documents
Command: npx skills add https://github.com/WesleyMFrederick/cc-workflows --skill writing-requirements-documents

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Create well-structured requirements documents (PRDs, epics, user stories) with Obsidian block anchors, wiki internal links, and citation-manager validation for link integrity.

Core Features & Use Cases

  • Obsidian-native linking with block anchors
  • Cross-document references using markdown links
  • RFC 2119 keyword usage for requirements (SHALL, SHOULD, MAY)
  • Validation with citation-manager for link integrity

Quick Start

Create a requirements document section for a new feature, ensuring block anchors, internal references, and cross-document links, validated by citation-manager.

Frequently Asked Questions about writing-requirements-documents

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

FAQPage Schema
How do I create requirements documents with Obsidian block anchors and wiki links?

Block anchors and wiki links enable traceable requirements in Obsidian. Structure your document with RFC 2119 keywords (SHALL, SHOULD, MAY), assign ID formats like FR1 or NFR1 to requirements, add block anchors (^FR1) after each requirement, then link internally using [[#^FR1|FR1]] syntax for cross-document references and validation.

What's the best way to ensure link integrity across multiple requirements documents?

Link integrity across documents requires citation-manager validation as a final quality gate. After creating cross-document markdown links and internal wiki references, run citation-manager to detect broken anchors, missing block references, and malformed links before publishing your requirements.

Can I use Obsidian wiki links for functional requirements, acceptance criteria, and user stories?

Yes. Obsidian wiki links work for all requirement types—PRDs, functional and non-functional requirements, epics, user stories, and acceptance criteria. Use block anchors to tag each item, apply consistent ID formats (FR/NFR/AC), and cross-link them with [[#^ID|ID]] references to build traceability matrices within a single vault.

How do I structure a PRD with traceability between requirements and acceptance criteria?

Structure your PRD by assigning unique block anchors to each requirement and acceptance criterion, then link them using wiki link syntax. Each FR gets ^FR1, each AC gets ^AC1. Link acceptance criteria back to their requirements with [[#^FR1|depends on FR1]], then validate all links with citation-manager before finalizing.

What happens if my requirements document has broken or invalid links?

Citation-manager validation detects broken anchors, missing block references, and malformed markdown links. Run validation before publishing to catch dead references; the tool flags unlinked IDs and orphaned blocks, ensuring your traceability chain stays intact across all documents in your vault.

Do I need RFC 2119 keywords in my requirements, or are they optional?

RFC 2119 keywords (SHALL, SHOULD, MAY, MUST NOT) enforce clarity on requirement enforcement. Using them is recommended to distinguish mandatory (SHALL) from optional (SHOULD) behavior, making acceptance criteria precise and traceable across cross-document links.