Why does it exclude Table of Contents and roadmaps?

The skill treats the README as an engineering specification for the current state, assuming a competent audience that benefits more from direct facts than navigational fluff or future plans.

Can I use emojis with this skill?

No, the style guide explicitly avoids emojis and emdashes to maintain a professional, minimalist technical tone.

Is this skill invocable via command?

No, it is a non-invocable skill intended to guide Claude's behavior automatically whenever it is tasked with creating or updating README.md files.

What does the md-style skill do?

It provides a set of rules and templates to ensure README files are concise, direct, and free of marketing language or redundant explanations.

Engineering README Stylist

Name: Engineering README Stylist
Author: jimweller

byjimweller

0•

Gestión de Contenido

Enforces a concise, fluff-free writing style for technical README documentation tailored for experienced engineers.

The md-style skill is designed to streamline the creation and maintenance of project documentation by enforcing an engineering-first writing philosophy. It eliminates verbose explanations, marketing hyperbole, and redundant information, focusing instead on high-signal data like architecture diagrams, installation commands, and configuration tables. By adhering to a strict structure and direct voice, this skill ensures that README files serve as efficient technical specifications rather than promotional materials, making them ideal for high-velocity development environments.

Características Principales

01Enforces 'No Fluff' principles to remove redundant or verbose content

02Eliminates marketing language and hyperbolic 'production-ready' claims

030 GitHub stars

04Standardizes technical formatting using tables for structured data

05Provides a standardized structure for usage, architecture, and configuration sections

06Filters out non-essential elements like roadmaps and tables of contents

Casos de Uso

01Standardizing internal project documentation across a large engineering team

02Refactoring existing verbose README files into concise technical specifications

03Generating high-signal documentation for complex infrastructure or data projects

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add jimweller/davit-dataops-dotfiles md-style

For use in Claude.ai and ChatGPT

Download Skill