skills.rest
salverius-tech
salverius-techCOMMUNITY
Explore all skills by this author →
GitHub

docs-workflow

Enforce documentation standards and automate validation for Markdown files.

Updated Apr 11, 2023
Search Tags:#linting#documentation#markdown#technical writing#adr#rfc
One-click install
npx skills add https://github.com/salverius-tech/dotfiles --skill docs-workflow-salverius-tech
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs-workflow
Source: https://github.com/salverius-tech/dotfiles/tree/main/home/dot_claude/skills/docs-workflow
Command: npx skills add https://github.com/salverius-tech/dotfiles --skill docs-workflow-salverius-tech

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill standardizes and improves the quality of your documentation by providing clear guidelines and automated checks for common documentation formats like Markdown.

Core Features & Use Cases

  • Markdown Linting & Formatting: Ensures consistency and adherence to standards.
  • Link Checking: Verifies that all internal and external links are valid.
  • Standardized Formats: Provides templates and best practices for RFCs, ADRs, and Design Docs.
  • Use Case: When writing a new technical specification, use this Skill to ensure it follows best practices for structure, formatting, and link integrity before it's merged.

Quick Start

Run the markdownlint command to check all markdown files in the current directory for style issues.

Frequently Asked Questions about docs-workflow

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

FAQPage Schema
How do I enforce markdown linting and formatting standards for technical documentation?▼

Markdown linting enforces documentation standards by validating style and formatting rules across your files. This Skill automates that validation to ensure consistency and adherence to standards for technical documentation.

What's the best way to validate links in markdown files and RFCs?▼

Link checking validates that all internal and external links in your documents are valid. This Skill automates link verification for Markdown files, RFCs, and specifications to maintain high-quality technical documentation.

How does documentation automation work with CI/CD pipelines?▼

Documentation automation integrates with CI/CD pipelines by running linting, formatting, and link checks automatically. This Skill enforces documentation standards during continuous integration to ensure maintainable technical docs.

Do I need a specific template for writing ADRs and RFCs?▼

ADRs and RFCs require standardized formats for structure and best practices. This Skill provides templates and validation for Architecture Decision Records, Requests for Comments, and design docs.

Can I check markdown files for style issues before merging a technical specification?▼

Checking markdown files for style issues before merging ensures technical specifications follow best practices. This Skill validates structure, formatting, and link integrity for your documentation prior to merge.

Why does technical documentation require automated validation?▼

Automated validation prevents broken links and inconsistent formatting in technical documentation. This Skill solves this by enforcing documentation standards and automating checks for Markdown, RFCs, and ADRs.

Related Skills

Explore More Content & Communication Skills→
ddttomddttom

md-workflow

Create, edit, and lint Markdown files with YAML frontmatter awareness.

Community
Intermediate
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced
mcj-codermcj-coder
1

documentation-as-code

Lint, spell-check, and validate links in Markdown documentation files.

Community
Intermediate
wwa-labwwa-lab

legacy-html-exporter

Convert Markdown files to standalone HTML companion documents.

Official
Basic