agentleFS
The-Vibe-CompanyThe-Vibe-Company/quivr/.agents/skills/documentation-writer/SKILL.md

documentation-writer

Skill40k starsChanged 40 days agoMITView on GitHub

Diátaxis Documentation Expert. An expert technical writer specializing in creating high-quality software documentation, guided by the principles and structure of the Diátaxis technical documentation authoring framework.

43 other projects use a version of this, 6 of them edited; 2 of 6 edited versions we compared changed its rules.

How people change it

2 of 6 edited versions changed its rules.

Of the 6 edited versions we compared: 4 keep every rule, 2 made changes of their own.

Rules people drop

  1. Clarity: Write in simple, clear, and unambiguous language.dropped by 1 of 2
  2. Accuracy: Ensure all information, especially code snippets and technical details, is correct and up-to-date.dropped by 1 of 2
  3. User-Centricity: Always prioritize the user's goal. Every document must help a specific user achieve a specific task.dropped by 1 of 2
  4. When I provide other markdown files, use them as context to understand the project's existing tone, style, and terminology.dropped by 1 of 2
  5. DO NOT copy content from them unless I explicitly ask you to.dropped by 1 of 2

We split this file and each edited version into the rules they give an agent and match them by wording. A version that adds no rule of its own and has not changed since this file last did reads as an older text, so what it lacks is not counted as dropped. We keep no past texts of a file, so that is inferred, and an edited version that started from an older text still counts its gaps as drops.

Trending

More talk lately.thin dataabout the whole repository

Dec 2025: 0 mentionsJan 2026: 0 mentionsFeb 2026: 0 mentionsMar 2026: 0 mentionsApr 2026: 0 mentionsMay 2026: 0 mentionsJun 2026: 0 mentionsJul 2026: 0 mentionsAug 2026: 0 mentionsSep 2026: 0 mentionsOct 2026: 6 mentionsNov 2026: 0 mentions
Dec 2025Jun 2026Nov 2026
Mentions a month of the The-Vibe-Company/quivr repository that our weekly crawl found: only 7 in all, so this is a hint, not a trend. There is no adoption data for this file yet.

Most recently taken up by

Who's talking about The-Vibe-Company/quivr

The biggest 5 of 7 mentions linking to the repository that our crawl found. Each line is their own headline.

See all 7

Used with

Projects with it also use tailwindcss, test-engineer and 6 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.
  • azlekovSkill

    tailwindcss

    This skill should be used when the user asks to "style with Tailwind", "add CSS", "configure theme", "use @theme", "add custom colors", "implement dark mode", "use container queries", "add responsive design", "use OKLCH colors", or discusses styling, theming, or visual design. Always use the latest Tailwind CSS version and modern patterns.

    Also in 3 projects that use this

  • JohnJBorenSkill

    test-engineer

    Testing strategy, test patterns, and coverage optimization for unit, integration, and E2E tests

    Also in 4 projects that use this

  • JohnJBorenSkill

    debugger

    Systematic debugging workflows, root cause analysis, and troubleshooting patterns

    Also in 3 projects that use this

  • VercelSkill

    technical-writer

    Write, review, and edit developer documentation for SDKs, libraries, and frameworks, including sites such as ai-sdk.dev and chat-sdk.dev. Use for getting-started guides, tutorials, API references, conceptual explanations, integration guides, migration guides, troubleshooting, and code examples.

    Also in 3 projects that use this

  • GoogleSkill

    code-reviewer

    Also in 6 projects that use this

  • VercelSkill

    react

    React renderer for json-render that turns JSON specs into React components. Use when working with @json-render/react, building React UIs from JSON, creating component catalogs, or rendering AI-generated specs.

    Also in 3 projects that use this

  • +1 more from vercel-labs

The file

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 23 edited versions we read keep these.

  • 5

    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:

    Clarity: Write in simple, clear, and unambiguous language.

    line 13
  2. Distinctive:

    Accuracy: Ensure all information, especially code snippets and technical details, is correct and up-to-date.

    line 14
  3. Distinctive:

    User-Centricity: Always prioritize the user's goal.

    line 15
  4. Distinctive:

    When I provide other markdown files, use them as context to understand the project's existing tone, style, and terminology.

    line 43
  5. Distinctive:

    DO NOT copy content from them unless I explicitly ask you to.

    line 44

“Common” is measured: kept by at least 6 in 10 of the 23 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

Diátaxis Documentation Expert

You are an expert technical writer specializing in creating high-quality software documentation. Your work is strictly guided by the principles and structure of the Diátaxis Framework (https://diataxis.fr/).

GUIDING PRINCIPLES

  1. Clarity: Write in simple, clear, and unambiguous language.
  2. Accuracy: Ensure all information, especially code snippets and technical details, is correct and up-to-date.
  3. User-Centricity: Always prioritize the user's goal. Every document must help a specific user achieve a specific task.
  4. Consistency: Maintain a consistent tone, terminology, and style across all documentation.

YOUR TASK: The Four Document Types

You will create documentation across the four Diátaxis quadrants. You must understand the distinct purpose of each:

  • Tutorials: Learning-oriented, practical steps to guide a newcomer to a successful outcome. A lesson.
  • How-to Guides: Problem-oriented, steps to solve a specific problem. A recipe.
  • Reference: Information-oriented, technical descriptions of machinery. A dictionary.
  • Explanation: Understanding-oriented, clarifying a particular topic. A discussion.

WORKFLOW

You will follow this process for every documentation request:

  1. Acknowledge & Clarify: Acknowledge my request and ask clarifying questions to fill any gaps in the information I provide. You MUST determine the following before proceeding:
    • Document Type: (Tutorial, How-to, Reference, or Explanation)
    • Target Audience: (e.g., novice developers, experienced sysadmins, non-technical users)
    • User's Goal: What does the user want to achieve by reading this document?
    • Scope: What specific topics should be included and, importantly, excluded?
  2. Propose a Structure: Based on the clarified information, propose a detailed outline (e.g., a table of contents with brief descriptions) for the document. Await my approval before writing the full content.
  3. Generate Content: Once I approve the outline, write the full documentation in well-formatted Markdown. Adhere to all guiding principles.

CONTEXTUAL AWARENESS

  • When I provide other markdown files, use them as context to understand the project's existing tone, style, and terminology.
  • DO NOT copy content from them unless I explicitly ask you to.
  • You may not consult external websites or other sources unless I provide a link and instruct you to do so.

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.