agentleFS
Sign inStart free
samchonsamchon/ttsc/.agents/skills/documentation/SKILL.md

documentation

Skill359 starsChanged 18 days agoMITView on GitHub

Owns ttsc's writing rules and writes its READMEs, website guides, and doc comments. Use before writing or changing a README, anything under website/src/content, or a doc comment.

We split this skill into the rules it gives an agent

1 rule. 0 are common, 1 is distinctive, and 0 are very specific to this project.

  • 0

    Common

    Most of the 94 edited versions we read keep these.

  • 1

    Distinctive

    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 only what the reader needs and would not otherwise know.

    line 12

“Common” is measured: kept by at least 6 in 10 of the 94 edited versions of this file we could read. “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

Documentation

Good writing is the same for every reader: deliver the core point concisely and clearly. Only the reader, and so what the reader needs, differs by document.

Writing

  • Write only what the reader needs and would not otherwise know. Cut padding, repetition, preamble, filler, and closing summaries; completeness means covering what the reader needs, never longer phrasing.
  • One point, one sentence, one place. Give the reason when it is not obvious.
  • Say what to do rather than what to avoid; when a prohibition is needed, name the concrete pattern.
  • Plain English with one term per concept, and no emphasis capitals, em-dashes, emoji in prose, promotional adjectives, stock AI phrasing, or hedging.

Paragraphs And Lists

A paragraph is one topic. Start a new one when the topic changes and keep sentences on the same topic together; merging topics to save paragraphs and splitting every sentence are both failures. Write each paragraph on one source line.

Use a list for parallel items, for steps whose order changes the result, and for their sub-steps, marking a sublist differently from its parent, such as - items under a numbered list. Write an argument whose conditions, reasons, and exceptions depend on each other as prose. Use a table for repeated mappings and a code block for exact commands.

READMEs And Guides

These are read by a person using or extending ttsc.

  • A README is for the package's user: what it is, when to use it, installation, the smallest working setup, and a link to its guide. Leave internals, protocols, and edge cases to the guide.
  • A guide under website/src/content/docs/ serves one reader (consumer, package user, bundler user, runtime user, plugin author, or maintainer) and one task, with the options, examples, and troubleshooting that task needs. Package folders hold package use, development/ holds plugin authoring, and top-level pages hold cross-cutting tasks. Update the folder's _meta.ts when adding, renaming, or moving a guide.
  • Take every code example from code that runs.

Doc Comments

JSDoc and Go doc comments follow the Writing and Paragraphs And Lists rules above. What a public declaration's comment must say is the contracts Meaningful documentation chapter.

Download now (ZIP)

  • Other versions103 projects use a version of this.

    Word for word · 0

    None found.

    Edited · 0

    None found.

    Wrote their own version · 103

    1. anthropics/knowledge-work-plugins★ 34ksame name
    2. comet-ml/opik★ 23ksame name
    3. mozilla-firefox/firefox★ 14ksame name
    4. microsoft/fast★ 9.7ksame name
    5. mufeedvh/code2prompt★ 7.7ksame name
    6. BrowserWorks/waterfox★ 6.4ksame name
    7. samchon/typia★ 5.9ksame name
    8. github/gh-aw★ 5.5ksame name
    9. epicenter-md/epicenter★ 4.8ksame name
    10. EpicenterHQ/epicenter★ 4.8ksame name

    93 more not listed

    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.

  • Used alongsideProjects with it also use project-preferences, response-style and 10 more.

    Other files people use alongside this one.

    Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
    • DepressionCenterSkill

      project-preferences

      Apply repository-specific preferences when planning, implementing, or reviewing changes in this project.

      Also in 4 projects that use this

    • DepressionCenterSkill

      response-style

      Write prose in plain, natural English. Apply to every response, design discussion, review comment, commit message, pull request, and document, in any task.

      Also in 4 projects that use this

    • BrowserWorksSkill

      accessibility-frontend-review

      Performs an accessibility code review of a local diff or Phabricator revision in the style of the Firefox accessibility team. Use this skill whenever the user asks to review a Phabricator patch or revision for accessibility issues, mentions a D-number (like D284142) in the context of accessibility review, asks "does this patch have any a11y issues", or wants to check a diff against accessibility guidelines. Also use it when the user says things like "can you review this for a11y", "check this patch", or "give me an accessibility review of D[number]". Invoke proactively when the user pastes a phabricator.services.mozilla.com URL or shares a revision ID alongside any accessibility concern. Invoke when questions about the following topics are raised: aria properties, aria roles, high contrast mode, forced colors, prefers contrast, focus order, screen readers, assistive technology.

      Also in 4 projects that use this

    • BrowserWorksSkill

      android-new-module

      Guide for creating new Android gradle modules in the android-components project.

      Also in 4 projects that use this

    • +8 more from BrowserWorks
  • In this repository10 other files it gives its agents.

Does it work?

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

Reviews can't be read right now.

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.

Check your setup, free