ada-srs-writing

Writes and refines Software Requirements Specification documents using structured templates and a four-phase workflow.

Updated Jul 23, 2026
One-click install
npx skills add https://github.com/wubing7755/Ada --skill ada-srs-writing-wubing7755
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ada-srs-writing
Source: https://github.com/wubing7755/Ada/tree/main/skills/software-development/ada-srs-writing
Command: npx skills add https://github.com/wubing7755/Ada --skill ada-srs-writing-wubing7755

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Writing and maintaining a large Software Requirements Specification (SRS) often leads to inconsistent terminology, concept confusion, leaked implementation details, and broken numbering. This Skill provides a structured methodology for authoring and iteratively refining SRS documents so they stay self-contained, consistent, and verifiable. ## Core Features & Use Cases - Standard SRS Structure: Canonical section layout (Introduction, Overall Description, Functional/Non-Functional Requirements, Statistics, Appendices) with a REQ-F-XXX requirement format, priority symbols, and bilingual terminology conventions. - Four-Phase Refinement Workflow: Understand the current document, propose changes before executing, apply edits from foundational sections outward, then update indexes, statistics, and the change log. - Pitfall Catalog & Renumbering: Hard-won lessons on concept separation (Editor Tab vs Dock Panel vs ToolBar Entry), safe bulk replacement, requirement renumbering scripts, and SVG/Mermaid diagram rendering rules for VS Code previews. - Use Case: When asked to "optimize this SRS" or add new requirements to a multi-thousand-line requirements document, the Skill guides concept alignment, AC extension versus new-requirement decisions, and post-edit consistency checks. ## Quick Start Ask the assistant to refine the attached SRS document by fixing concept confusion between tabs and panels and updating all section indexes and statistics accordingly.

Frequently Asked Questions about ada-srs-writing

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

FAQPage Schema
How do I write a Software Requirements Specification document?

Structure the SRS with standard sections: Introduction, Overall Description, Functional Requirements, Non-Functional Requirements, Statistics, and Appendices. Format each requirement as REQ-F-XXX with a priority symbol, actor, description, and Given/When/Then acceptance criteria.

How to renumber requirements in an SRS without duplicate IDs?

Detect genuine requirement headers by matching the REQ-F-XXX pattern followed by Title and Description lines, build an old-to-new ID mapping in physical order, then replace using regex with negative lookarounds to prevent partial matches. Always git stash before renumbering for safe rollback.

Should requirements include implementation details like pixel values?

No. Requirements define behavior, not implementation constants like exact pixel values or hex colors. Behavioral parameters such as a 4px drag threshold or measurable performance targets like 200ms initialization are acceptable because they are testable constraints.

Why does my SVG diagram not render in VS Code Markdown preview?

VS Code requires every SVG line to be wrapped in a blockquote with a "> " prefix, rx must be an inline attribute rather than CSS, and special Unicode characters cause silent rendering failures. ASCII box diagrams are the most reliable alternative.

When should I extend acceptance criteria instead of adding a new requirement?

Extend an existing requirement's acceptance criteria when the new behavior derives directly from an existing constraint, keeping context centralized for reviewers. Create a new requirement only when the behavior is independent, numbering it after the current maximum ID.