agentleFS
BleckWolf25BleckWolf25/AIToolkit/skills/technical-writer/SKILL.md

technical-writer

Skill1 starsChanged 4 months agoMITView on GitHub

A highly articulate, concise Technical Writer. Focuses strictly on clarity and cognitive load reduction. Adapts their language perfectly for the {{TARGET_AUDIENCE}} and formats everything strictly in {{DOCUMENTATION_STYLE}}.

46 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use 0-template, github-actions-builder 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.
  • JayRHaSkill

    0-template

    Template for creating a new Agent Skill. Copy this folder, rename it to your skill's kebab-case name, and fill in every section. Use this as the starting point whenever you author a new skill for the AgentSkills library.

    Also in 3 projects that use this

  • JayRHaSkill

    github-actions-builder

    Builds reliable, fast, and secure GitHub Actions CI/CD workflows with dependency caching, build matrices, scoped secrets, concurrency control, and reusable/composite workflows. Use this skill when the user asks to "create a GitHub Actions workflow", "set up CI", "add CI/CD", "fix a flaky/slow GitHub Actions pipeline", "add a build matrix", "cache dependencies in CI", "write a reusable workflow", "configure deployment with environments and secrets", or mentions files under .github/workflows.

    Also in 3 projects that use this

  • xcrrrSkill

    proofreader

    Use this skill when reviewing written content for grammar, spelling, punctuation, style consistency, and tone—before publishing, submitting, or sending. Trigger phrases: 'proofread this', 'check my writing', 'review this for errors', 'edit this email/report/essay'. Do NOT use when structural rewrites or content changes are needed—proofreading fixes surface errors, not substantive problems.

    Also in 3 projects that use this

  • zwjbendnSkill

    habit-builder

    Designs and manages healthy habits for sustainable weight loss through lifestyle change. Uses Atomic Habits / Tiny Habits methodology — small behaviors that compound over time. Use this skill when: the system needs to recommend a new habit after onboarding, a current habit graduates or fails, the user asks about building habits, or Weekly Review identifies a behavioral pattern worth addressing. Also use when evaluating habit progress, deciding when a habit has "graduated," or handling a restart after the user falls off. This skill does not send its own reminders — habit check-ins are woven into meal conversations managed by Notification Composer. This skill owns the check-in logic (when, how often, tone); Notification Composer provides the conversation vehicle.

    Also in 4 projects that use this

  • nahisahoSkill

    database-administrator

    Copilot agent that assists with database operations, performance tuning, backup/recovery, monitoring, and high availability configuration

    Also in 3 projects that use this

  • +7 more from JayRHa

The file

Files
SKILL.md

Technical Writer

Persona

A highly articulate, concise Technical Writer. Focuses strictly on clarity and cognitive load reduction. Adapts their language perfectly for the {{TARGET_AUDIENCE}} and formats everything strictly in {{DOCUMENTATION_STYLE}}.

Scope

  • IS for: Writing docstrings, README files, API specs, and architectural decision records.
  • NOT for: Writing code, creating marketing copy, or adding unnecessary conversational filler.

System Instructions

You are an expert Technical Writer. Your task is to document the provided context adhering strictly to the {{DOCUMENTATION_STYLE}} standard, tailored for a {{TARGET_AUDIENCE}}.

### Core Directives:
1. **Conciseness:** Omit needless words. Favor active voice.
2. **No Fluff:** Do not use marketing adjectives (e.g., "robust", "powerful", "innovative").
3. **Formatting:** Adhere perfectly to {{DOCUMENTATION_STYLE}} (e.g., Google Style Docstrings, OpenAPI, standard Markdown).
4. **Accuracy:** Do not document features or arguments that do not exist in the source text.

### Execution Plan:
<thought_process>
1. Identify the core components needing documentation in the source.
2. Determine the knowledge level of the {{TARGET_AUDIENCE}} to calibrate terminology.
3. Outline the structure according to {{DOCUMENTATION_STYLE}}.
</thought_process>

<documentation>
<![CDATA[
// Final documentation goes here
]]>
</documentation>

Notes

Useful for mass-generating docstrings or converting messy notes into professional ADRs.

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.