deepchat-sdd

Creates RFC-style specs and implementation plans for substantial DeepChat changes.

6.3k|728|Updated Feb 14, 2025
One-click install
npx skills add https://github.com/ThinkInAIXYZ/deepchat --skill deepchat-sdd
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: deepchat-sdd
Source: https://github.com/ThinkInAIXYZ/deepchat/tree/main/.agents/skills/deepchat-sdd
Command: npx skills add https://github.com/ThinkInAIXYZ/deepchat --skill deepchat-sdd

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Substantial changes to the DeepChat codebase often lack a durable decision record and a clear execution path, making it hard for future developers to understand why and how work was done. This Skill enforces a spec-driven development (SDD) workflow that produces RFC-style specs and ordered implementation plans before code changes begin.

Core Features & Use Cases

  • Goal Classification: Routes work into docs/features, docs/issues, or docs/architecture folders based on whether it is a new capability, complex bug, or refactor.
  • RFC and Plan Artifacts: Generates a normative spec.md covering design, invariants, and acceptance criteria, plus plan.md as the single ordered implementation tracker.
  • Implementation-First Validation: Completes planned implementation before deciding on new tests, then selects the smallest useful validation and runs format, i18n, lint, and typecheck gates.
  • Use Case: When adding a new MCP integration to DeepChat, use this Skill to write an RFC in docs/features, track implementation slices in plan.md, and optionally sync a labeled GitHub issue after approval.

Quick Start

Use the deepchat-sdd skill to plan and document my new DeepChat feature before writing any code.

Frequently Asked Questions about deepchat-sdd

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

FAQPage Schema
How do I write a spec-driven development plan for a code change?

Classify the goal as a feature, complex bug, or architecture change, then create a kebab-case folder under docs with a spec.md RFC covering context, design, and acceptance criteria. Add plan.md as the only ordered implementation tracker for feature or architecture work.

When should I skip SDD documentation for a code change?

Skip SDD for trivial or tightly localized work such as visual style fixes, small UI layout adjustments, simple localized logic changes, and routine docs edits. Only create artifacts when the change needs shared context or a durable decision record.

Does this workflow sync changes to GitHub issues automatically?

No, GitHub issue sync is disabled by default and requires explicit developer request or approval. When approved, feature issues use the [feature] label, bug issues use the [bug] label, and PRs include Closes #NNN to auto-close issues.

Should I write tests before implementation in spec-driven development?

No, this workflow uses implementation-first validation where planned implementation completes before deciding on new tests. Exceptions include developer-requested TDD, minimal reproductions for complex failures, or characterizing migration and concurrency behavior.

What quality checks run before handing off DeepChat changes?

Run pnpm run format, pnpm run i18n, pnpm run lint, and pnpm run typecheck before handoff when app code, tests, i18n, or project docs changed. Temporary verification scripts must be removed before handoff.