agentleFS
JoaoEquerJoaoEquer/Oficina/skills/client-facing-docs/SKILL.md

client-facing-docs

Skill2 starsChanged 24 days agoMITView on GitHub

Writing client-facing technical documentation — architecture documents, proposals, project presentations — in plain language, jargon-free, with honest numbers and explicit pragmatic engineering principles. Use whenever the material will be read by a client or non-technical stakeholder - architecture doc, kickoff presentation, proposal, delivery report or closing email.

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:

    Real team, real roles: Only people actually allocated, each with their correct role.

    line 15
  2. Distinctive:

    No decorative Unicode borders and no emoji overload (they break rendering and age badly)

    line 23

≈ “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

Client-facing documentation

A document for a client is not a technical document with a nice cover. It is a different kind of writing.

Principles

  1. Zero untranslated jargon. "Monorepo" becomes "a single repository". "Multi-tenant" becomes "each company with its data isolated". "CI/CD" becomes "every change passes automated checks before going live". If a technical term must appear, a one-sentence explanation comes with it.
  2. Honest numbers. Hours, deadlines and scope reflect the real contract — never a partial version that "presents better". A wrong number in presented material is the kind of thing that erodes trust and is very expensive to fix later.
  3. Document scope = contracted scope. Future phases, product vision and commercial possibilities stay out of the MVP document (at most, a one-line note: "future evolutions depend on a new commercial cycle").
  4. Real team, real roles. Only people actually allocated, each with their correct role. Double-check before sending.
  5. Explicit engineering principles. A short section stating how the team decides: proven technology over trends, complexity only when the problem demands it, reversible decisions, honest deadlines. Clients understand and value it — and the document becomes an anchor when someone suggests the trend of the week.

House formats

Architecture/structure document (responsive HTML):

  • Sections: overview → what the system does → how it is organized (repos, modules) → team and roles → engineering principles → timeline/workstreams
  • Flowing prose, tables only where comparison demands them
  • No decorative Unicode borders and no emoji overload (they break rendering and age badly)

Presentation (fullscreen HTML deck):

  • Keyboard (←/→) and click navigation, progress bar, slide counter
  • One topic per slide, short sentences
  • Export to PDF for distribution via WhatsApp/email (the PDF is what circulates; the HTML is what presents)
  • Mandatory final check: deck numbers × contract numbers, before presenting

Closing email (weekly/delivery):

  • What was done (verifiable facts), what comes next, items pending on the client
  • Short: if it's longer than one screen, it became a report and nobody reads it

Checklist before sending any material

  • Numbers match the contract/execution plan
  • Team and roles verified
  • Jargon translated or eliminated
  • Scope limited to what was contracted
  • Rendering checked on the device the client will open it on (usually a phone)

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.