agentsclimarketplace
Sign in

Documentation

Skill CodeByVibes/agents-extras/skills/documentation

Provides guidelines and templates for writing consistent, high-quality documentation. Use when the user asks to write, generate, update, or format documentation (such as a README, ADR, Changelog, or API reference) across any language or framework.From its SKILL.md

Install
npx -y skills add CodeByVibes/agents-extras --skill documentation

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

2 things to look at

  • no licenseNo license file was found in the repository. Code published without one is not open source by default, so using it at work is a question for whoever answers licensing questions where you are.
  • 0 stars0 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

SKILL.md

2.4 KB, 453 tokens by cl100k_base, as published. Nobody here has run it

Documentation Skill

This skill provides comprehensive guidelines and templates for writing documentation.

Core Guidelines (Always Read)

Before starting any documentation task, ensure you review the core guidelines:

Validation Script

After generating or updating any Markdown documentation, you MUST run the validation script located in the scripts/ directory to ensure there are no formatting errors.

  • Windows: .\scripts\validate.ps1 <path_to_file.md>
  • Linux/Mac: ./scripts/validate.sh <path_to_file.md>

Context-Specific Guidelines

Depending on the task, you should read the relevant context-specific guidelines using your file reading tools.

Project Documentation

Language-Specific Documentation

When documenting code for a specific language, read the corresponding guidelines:

Framework-Specific Documentation

When working with specific frameworks, read these guidelines:

What ships with it: 34 files

19.9 KB alongside SKILL.md, 2 of them executable

core/

examples/

frameworks/

languages/

project/

scripts/

templates/

Keep looking

Skills are one crate of 325,949. Ordering is by how many stacks a row turns up in, so the top of any crate is what has actually been picked rather than what has the most stars.