easysdd-guidedoc

Community

Convert specs into clear user and dev guides

Authorliuzhengdongfortest
Version1.0.0
Installs0

System Documentation

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.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: easysdd-guidedoc
Download link: https://github.com/liuzhengdongfortest/easysdd/archive/main.zip#easysdd-guidedoc

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.