md-style

Name: md-style
Author: jimweller

github.com/jimwellerDocuments69 installs

About md-style

A README-writing skill for experienced engineers that defines which sections to include and how to order them. It focuses on concise documentation of a project's current state rather than history or future plans.

Key features

01Prescribed README section order
02Current-state documentation
03Exclusion of fluff and roadmaps
04Formatting guidance for tables and code

Use cases

01Structuring an engineering README
02Editing an overly long README
03Documenting project configuration and testing

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/jimweller/clanker-skills --skill md-style

After installing, type/md-stylein Claude Code to confirm it loaded.

Details

From the project README

README Style Guide

Write concise, direct README files for experienced engineers.

Voice

Prose style is not defined here. The clanker-prose plugin's prose-contract owns it, injected via a SessionStart hook pointer to its two sections:

Ghostwriting for Other Humans - a README is read by another human, so it takes the ghostwriting contract: minimum facts, one fact per sentence, the deletion test on every word
Banned Patterns in All Writing - the catalog of forbidden words and constructions, including hype vocabulary, opposing phrases, phantom-foil contrast, emojis, and emdashes

This skill covers what belongs in a README and in what order.

Principles

No fluff - Skip tables of contents, verbose explanations, development history
No roadmaps - Document current state only, not plans or decisions. Readme is an engineering specification. Not a project plan or changelog.

Structure

Sections in order: Overview, Prerequisites, Usage, Architecture, Configuration, Testing, File Structure. One-line purpose statement at top under H1.

Exclude

Tables of contents
Verbose troubleshooting guides
Development decisions/history
Future plans/roadmaps
Lengthy explanations of concepts
Multiple examples of similar things

Formatting

Tables for structured data (components, variables, test coverage)
Code blocks for commands and examples
Bold for emphasis sparingly

Comments

Markdown supported

Details

Author: jimweller
Repository: jimweller/clanker-skills
Category: Documents
Installs: 69

Report

More skills

All skills

handoff

github.com/mattpocock

1.1M

Compact the current conversation into a handoff document for another agent to pick up

lark-doc

open.feishu.cn

831.4k

Operate on Feishu cloud documents (Docx / Wiki): read, create, and edit documents; insert or download image attachments; and work with mind notes. Use when the user provides a document URL/token (including /docx/ or /wiki/ on doubao.com); route by URL path/token rather than domain. `/page/<token>` is a Miaoda app, not a Feishu cloud document. Route embedded document resources according to the unified rules in the reading reference. Use lark-drive for standalone comment operations; use docs +fetch to read comments alongside the main text. Operations on spreadsheet or Base internal data are outside this skill.

lark-drive

open.feishu.cn

830.7k

Feishu cloud storage (Drive): manage Drive files and folders, including uploads/downloads, folder creation, copying/moving/deleting, viewing metadata, checking permission settings, comments/permissions/subscriptions, titles, versions, Feishu document security labels (secure labels), and local file imports. Use when users need to organize Drive folders, handle cloud storage resource URLs/tokens, identify link types/actual tokens/titles, or import Word/Markdown/Excel/CSV/PPTX/.base as docx/sheet/bitable/slides. Route doubao.com cloud storage URLs/tokens by resource path and token too; do not fall back to WebFetch. Not responsible for: editing document content (use lark-doc), spreadsheet/Base table data operations (use lark-sheets/lark-base), knowledge space node/member management (use lark-wiki), or native Markdown file read/write/patch/diff (use lark-markdown).

lark-sheets

open.feishu.cn

829.3k

Feishu Spreadsheets: create and operate spreadsheets. Supports worksheets and row/column structures (add/delete/merge/size/hide/freeze/group), cell read/write (values/formulas/styles/comments/cell images), range copy/move/sort/fill, find and replace, bulk updates, and creating and maintaining objects such as charts, pivot tables, conditional formatting, filters and filter views, dropdown lists, sparklines, and floating images. Also supports formula validation, restoring historical versions, and importing/exporting local Excel/CSV files and Feishu spreadsheets. Use when users need to create or edit spreadsheets, summarize and visualize data, format spreadsheets, calculate formulas (including migrating Excel formulas), or build financial models (DCF, three statements, budgets, Sensitivity, etc.). For multidimensional tables (Base/bitable), use lark-base. If users want to search for spreadsheet files in cloud storage (Drive/cloud storage) by name or keyword, use lark-drive's drive +search to locate resources first. When users provide a doubao.com /sheets/ URL/token, use this skill directly; do not fall back to WebFetch because the domain is not Feishu. Routing is based on the URL path pattern and token, not the domain.