easysdd-guidedoc

Draft developer and user guides from project specs and code.

1.1k|82|Updated Apr 12, 2026
One-click install
npx skills add https://github.com/liuzhengdongfortest/easysdd --skill easysdd-guidedoc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: easysdd-guidedoc
Source: https://github.com/liuzhengdongfortest/easysdd/tree/main/easysdd-guidedoc
Command: npx skills add https://github.com/liuzhengdongfortest/easysdd --skill easysdd-guidedoc

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Projects often have specs and code but lack concise, role-targeted documentation; contributors and end users cannot quickly find how to use or integrate features. This Skill transforms internal specs and implementation details into publishable developer and user guides that are readable, actionable, and version-controlled so teams and downstream users can rely on stable documentation.

Core Features & Use Cases

  • Drafts dev-guide and user-guide documents with the required YAML frontmatter fields and recommended structure.
  • Detects existing guides, classifies updates versus new documents, and recommends marking old content as outdated when code diverges.
  • Outputs guides to docs/dev/{slug}.md or docs/user/{slug}.md and enforces status transitions (draft → current, mark outdated when necessary).
  • Typical use cases: repository onboarding, feature acceptance handoff, documentation updates after API or UI changes.

Quick Start

Ask the skill to draft or update a dev-guide for the auth component by summarizing the spec and code and writing docs/dev/auth.md with status current.

Frequently Asked Questions about easysdd-guidedoc

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

FAQPage Schema
How do I generate developer and user guides from project specs?

Generate developer and user guides by transforming internal specs and implementation details into publishable, version-controlled markdown files. The process drafts role-targeted documents with structured YAML frontmatter, enforcing required fields like doc_type, slug, component, status, and tags for clear repository integration.

What is the best way to keep documentation synchronized with code changes?

Keep documentation synchronized with code changes by detecting existing guides, classifying updates versus new documents, and marking old content as outdated when code diverges. This ensures team members and downstream users always rely on current, stable guides located in docs/dev or docs/user directories.

How do I write a dev-guide with YAML frontmatter for repository onboarding?

Write a dev-guide by summarizing the spec and code, then outputting the file to docs/dev/{slug}.md. Enforce the YAML frontmatter schema including doc_type, slug, component, status, summary, tags, and last_reviewed, transitioning the document status to current once the draft is complete.

Does spec-driven documentation work for feature acceptance handoff?

Spec-driven documentation works for feature acceptance handoff by converting specs and implementation details into actionable, role-targeted guides. It outputs structured files under docs/user or docs/dev, ensuring downstream users and contributors can quickly verify and integrate new features.

When should I mark existing guides as outdated during documentation updates?

Mark existing guides as outdated during documentation updates when the code diverges from the previously documented spec. The system detects these mismatches, classifies the update requirement, and applies the outdated status transition to prevent users from relying on stale information.