Does it support specific programming languages?

Yes, it includes customized documentation guidance for popular ecosystems including Python, JavaScript/Node.js, Go, and Rust.

Does this skill follow specific industry standards?

Yes, it implements best practices like progressive disclosure, clear installation paths, and standardized section ordering used by top open-source projects.

What types of documentation can this skill generate?

This skill provides comprehensive standards and templates for README.md files, CONTRIBUTING.md guides, and SUPPORT.md documentation.

How does it handle different project types?

The skill adapts its recommendations based on whether you are building a library/package, a full application, or a CLI tool.

Documentation Standards (Readme & Co)

Name: Documentation Standards (Readme & Co)
Author: aaronbassett

byaaronbassett

•

Learning & Documentation

Generates professional GitHub repository documentation including READMEs, contributing guides, and support resources based on industry best practices.

This skill empowers developers to create high-quality, comprehensive documentation for software projects by providing structured guidance for essential repository files. It automates the creation of README.md, CONTRIBUTING.md, and SUPPORT.md files using industry-standard patterns tailored to specific project types like libraries, CLI tools, and web applications. By following principles of progressive disclosure and consistency, it ensures that your project is accessible to users and easy for contributors to join, regardless of the programming language or framework used.

Key Features

011 GitHub stars

02Language-specific guidance for Python, JavaScript, Go, and Rust projects

03Automated documentation checklists for completeness and clarity

04Tailored documentation patterns for libraries, applications, and CLI tools

05Standardized templates for README, CONTRIBUTING, and SUPPORT files

06Best practice implementation for progressive disclosure and maintainability

Use Cases

01Creating clear contributor guidelines to streamline the pull request process

02Standardizing documentation across a suite of internal company repositories

03Initializing professional documentation for a new open-source project

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add aaronbassett/aaronbassett-marketplace documentation-standards

For use in Claude.ai and ChatGPT

Download Skill