skills.rest
goranjovic55
goranjovic55COMMUNITY
Explore all skills by this author →
GitHub

documentation

Enforce Markdown documentation structure and formatting patterns via skill.yaml configuration.

Updated Dec 24, 2025
Search Tags:#templates#documentation#markdown#readme#patterns#governance#api-docs
One-click install
npx skills add https://github.com/goranjovic55/NOP --skill documentation-goranjovic55
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/goranjovic55/NOP/tree/main/.github/skills/documentation
Command: npx skills add https://github.com/goranjovic55/NOP --skill documentation-goranjovic55

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Keeping Markdown docs consistent and high-quality across large repos.

Core Features & Use Cases

  • Documentation structure patterns and templates for READMEs, API docs, and changelogs.
  • Automated guidance for headings, sections, and best-practice formatting.
  • Use cases include onboarding contributors, maintaining project docs, and enforcing standards.

Quick Start

Edit Markdown files in your docs/ directory to apply the documented patterns and templates.

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I enforce structure and best practices in Markdown documentation?▼

You can enforce Markdown documentation structure by applying configurable patterns and templates to your docs directory, README, and CHANGELOG files. This ensures consistent headings, sections, and formatting across your repository.

What is the best way to maintain consistent README and API docs across a large repository?▼

The best way to maintain consistent README and API docs is using configurable templates that guide writers during editing. This enforces standardized formatting and governance patterns across all project documentation.

How do I configure triggers and file organization rules for Markdown documentation?▼

You configure Markdown documentation triggers, patterns, templates, and file organization rules using a skill.yaml file. This configuration defines the specific governance patterns applied when editing files in the docs directory.

Can I use documentation templates for onboarding new contributors to a project?▼

Yes, you can use documentation templates for onboarding contributors by providing standardized README, API docs, and changelog structures. This ensures new contributors follow established patterns and formatting guidelines.

What are the limitations of automated guidance for Markdown formatting?▼

Automated guidance for Markdown formatting is limited to enforcing structure, headings, sections, and best-practice patterns within the docs directory, README, and CHANGELOG. It does not generate documentation content automatically.

Related Skills

Explore More Content & Communication Skills→
longbridgelongbridge
12.5k

generate-component-documentation

Generate Markdown documentation for new components using existing docs templates.

Official
Intermediate
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced
auldsyababuaauldsyababua
6

markdown-validation

Validate Markdown files for syntax, links, and formatting standards.

Community
Advanced
dt418dt418

Docs Pack

Build documentation platforms with versioned docs, search, navigation, code highlighting, and API reference generation.

Community
Intermediate