AI SummaryProvides guidance for editing markdown documentation files in sysdoc repositories using the sysdoc CLI tool. Developers working with system documentation standards will benefit from quick reference to templates and initialization commands.
Install
Copy this and paste it into Claude Code, Cursor, or any AI assistant:
I want to install the "sysdoc-edit" skill in my project. Please run this command in my terminal: # Install skill into the correct directory mkdir -p .claude/skills/claude-skill-sysdoc && curl --retry 3 --retry-delay 2 --retry-all-errors -o .claude/skills/claude-skill-sysdoc/SKILL.md "https://raw.githubusercontent.com/sysdoc-rs/claude-skill-sysdoc/master/SKILL.md" Then restart Claude Code (or reload the window in Cursor) so the skill is picked up.
Description
Guide for editing markdown files in sysdoc system documentation repositories. Apply when creating or modifying .md files in src/ folders.
Initialize a Document
Create a new document from a DID template: `sh sysdoc init <TEMPLATE> [PATH] ` Options: • -t, --title <TITLE> - Set document title • -f, --force - Overwrite existing files Available templates: | Alias | DID Number | Description | | ----- | -------------- | --------------------------------- | | SDD | DI-IPSC-81435B | Software Design Description | | SRS | DI-IPSC-81433A | Software Requirements Specification | | IDD | DI-IPSC-81436A | Interface Design Description | | SSS | DI-IPSC-81431A | System/Subsystem Specification | | SSDD | DI-IPSC-81437A | System/Subsystem Design Description | | STP | DI-IPSC-81438 | Software Test Plan | | STD | DI-IPSC-81439 | Software Test Description | | STR | DI-IPSC-81440 | Software Test Report | | TR | DI-MISC-80508B | Technical Report | Example: `sh sysdoc init SDD ./my-document -t "My Project Design" `
Build Documentation
Build markdown sources to various output formats: `sh sysdoc build [PATH] -f <FORMAT> -o <OUTPUT> ` Output formats: • docx - Microsoft Word • markdown - Markdown with images folder • html - HTML with embedded images • pdf - PDF with embedded images and TOC Options: • -w, --watch - Watch for changes and rebuild automatically • -v, --verbose - Verbose output • --no-toc - Skip table of contents generation Examples: `sh sysdoc build ./src -f docx -o ./output/document.docx sysdoc build -f pdf -w # Watch mode with PDF output `
Validate Document
Check document structure and references: `sh sysdoc validate [PATH] ` Options: • -v, --verbose - Show detailed results • --check-links - Validate internal references • --check-images - Verify image files exist • --check-tables - Validate CSV table references Example: `sh sysdoc validate ./src --check-links --check-images ` ---
Section Numbers
• sysdoc auto-generates section numbers from filenames - never include them in headings • Write # Purpose not # 1.1 Purpose
Discussion
Health Signals
My Fox Den
Community Rating
Sign in to rate this booster