agentleFS
liangminhualiangminhua/agent-notes-toolkit/skills/prose-standard/SKILL.md

prose-standard

Skill0 starsChanged 3 months agoMITView on GitHub

Use when writing, reviewing, restoring, trimming, or auditing prose — deciding where documentation or comments are required, preserving every factual clause, and deleting reasoning-transcript residue.

1 other project uses a version of this, 1 of them edited.

Adopted by

Most recently taken up by

  • Other versions1 project uses a version of this.

    Word for word · 0

    None found.

    Edited · 1

    1. zehuichan/vibe-harness★ 219% same

    Wrote their own version · 0

    None found.

    How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.

  • In this repository6 other files it gives its agents.

The file

We split this skill into the rules it gives an agent

2 rules. About 0 are common, 2 are distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Write enough to preserve the contract, then remove reasoning transcripts, repetition, and decoration.

    line 8
  2. Distinctive:

    Public JSDoc: document caller-visible return distinctions, throws or rejections, side effects, ownership, timing, cancellation, and …

    line 16

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Prose Standard

Write enough to preserve the contract, then remove reasoning transcripts, repetition, and decoration. A contract is an obligation, invariant, precondition, postcondition, or compatibility promise that a caller, callee, implementer, producer, or consumer relies on.

Preserve the complete proposition

Before editing, identify every proposition in the passage. Preserve each relevant: actor and action; condition, timing, and ordering; modality such as must, may, or never; negative guarantee and exception; ownership, side effect, failure mode, and consequence. Remove adjectives, repetition, and narration only when every factual clause survives and the result is clearer. A smaller word count alone is not an improvement.

Required coverage by prose location

  • Public JSDoc: document caller-visible return distinctions, throws or rejections, side effects, ownership, timing, cancellation, and durability.
  • Internal comments: orient non-local structure and obviously complicated local structure — invariants, race ordering, ownership, security boundaries, surprising failure behavior. Delete control-flow narration and code restatement.
  • Module comments: state the module's role, dependencies, responsibilities, and non-obvious architecture choices.
  • Tests: explain only non-obvious test design — why a fixture, assertion, platform accommodation, or indirect observation is necessary. Delete walkthroughs and inventories.
  • READMEs: include the consumer contract: configuration, semantics, failures, limitations, extension points. Keep durable gaps, not ordinary cleanup inventories.
  • Agent Notes: retain unique rationale, mechanisms, alternatives, consequences, shipped verification evidence, and named coverage gaps. Implemented notes state shipped reality in the present tense.
  • Skills and agent instructions: state behavioral guardrails and explicit scope limitations. Keep the workflow concise.

Keep a complete local contract at the point of use: behavior, failure, ownership, and consequence that a caller or maintainer needs there. Link to the owning document for architecture, rationale, algorithms, history, or extended examples. One explanation has one home; essential contract facts may repeat locally.

Borderline decisions

A case is borderline only when at least two versions satisfy the complete-proposition rule but trade accepted principles. Do not weaken a proposition to make progress; report genuinely borderline cases without asking questions in automatic mode.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.