Write and update developer and user guide documents in project docs directories.
npx skills add https://github.com/wildlily1021/XW_Software --skill cs-guide-wildlily1021
Please help me install this Agent Skill. Skill: cs-guide Source: https://github.com/wildlily1021/XW_Software/tree/main/.agents/skills/cs-guide Command: npx skills add https://github.com/wildlily1021/XW_Software --skill cs-guide-wildlily1021
docs/dev/ and user-guides (feature overview, step-by-step operations, FAQ) in docs/user/. - Lifecycle management: Uses YAML frontmatter with draft/current/outdated status, detects existing guides via search to avoid duplicates, and marks stale docs when code changes. - Workflow integration: Triggers proactively after feature acceptance—interface changes prompt dev-guide updates, user-visible changes prompt user-guide updates. - Use Case: After finishing a feature acceptance, the Skill asks whether the interface contract changed, then drafts a dev-guide with quick-start examples and API reference derived from the design spec. ## Quick Start Ask the assistant to write a developer guide for the feature you just finished, and it will draft a structured document in docs/dev/ for your review.High-intent search queries and answers about installing and using this skill.
Read the spec's terminology and interface contract sections, check docs/dev for existing guides on the same component, then draft using the dev-guide structure: overview, prerequisites, quick start, core concepts, API reference, and common scenarios. Set status to draft until reviewed.
Dev-guides target contributors and integrators with setup, architecture, and API details, stored in docs/dev. User-guides target end users with feature overviews, step-by-step operations, and FAQs, stored in docs/user. One feature often needs both.
Mark a guide outdated when the corresponding code has changed but the document has not been updated. Keep the original content with the outdated flag as reference, then write a fresh version rather than silently editing stale material.
No. Guides are publishable documents for external readers and must not contain internal spec content such as implementation hints, invariants, test constraints, or root-cause analysis. Those belong in the codestable spec directory.
Search the docs directories with the YAML search tool filtering by doc_type and component before drafting. If an existing guide is found, treat the task as an update: minor edits modify in place, major restructures mark the old one outdated first.
Priivacy-aiGuides documentation missions in Spec Kitty to keep docs aligned with shipped behavior.
scanadyGenerate functional-first READMEs, quickstart guides, and technical overviews for repository onboarding.
mindspore-aiProvide reference documentation for Triton's core CUDA APIs including tl.load, tl.store, tl.dot, tl.ammo, tl.atomic and tl.async_copy with usage examples for building GPU kernels.
savvy-webGenerate RSPress API documentation from TypeScript source files.