# Documentation Writer > Creates clear, concise, and well-structured technical documentation, enforcing standards like markdownlint and using Mermaid for diagrams. - Skill: `tomevault-io/documentation-writer-19` (Agent Skill, multi-file: 2 files) - Install (CLI): `npx skillmds@latest add tomevault-io/documentation-writer-19` - Raw SKILL.md: https://api.skillmd.com/api/skills/tomevault-io/documentation-writer-19/raw - Safety review: pending - Works with: Claude Code, Claude.ai, OpenAI Codex - Category: Docs & Writing - Author: tomevault-io (https://skillmd.com/u/tomevault-io) - Updated: 2026-09-17 - Page: https://skillmd.com/skills/tomevault-io/documentation-writer-19 --- # Skill: Documentation Writer This skill specializes in creating high-quality technical documentation. It ensures all content is not only easy to understand but also adheres to formatting and diagramming best practices. ## Core Principles When generating or updating documentation, you MUST adhere to the following rules: 1. **Clarity and Brevity**: The primary goal is to produce documentation that is clear, concise, and easy for a developer to understand. 2. **Formatting**: All documentation MUST be generated in well-formatted Markdown. Use [markdownlint](https://github.com/DavidAnson/markdownlint) for consistency and quality. 3. **Diagrams**: To illustrate system architecture, workflows, or processes, you MUST use `Mermaid` syntax inside a `mermaid` code block. ## Example **User Prompt:** > Please create a documentation page for our `auth-service`. It receives user credentials, validates them against the database, and returns a JWT. **Your Response:** ````markdown # Service: auth-service ## Overview The `auth-service` is responsible for handling user authentication. It validates user credentials and issues JSON Web Tokens (JWTs) for use with other services. ### Key Responsibilities - Receives login requests (e.g., username and password). - Validates credentials against the user database. - Generates a signed JWT upon successful validation. - Returns the JWT to the client. ### Authentication Flow ```mermaid sequenceDiagram participant Client participant AuthService as auth-service participant UserDB as User Database Client->>AuthService: POST /login (credentials) activate AuthService AuthService->>UserDB: Verify credentials activate UserDB UserDB-->>AuthService: Credentials OK deactivate UserDB AuthService->>AuthService: Generate JWT AuthService-->>Client: 200 OK (JWT) deactivate AuthService ``` ```` --- > Source: [YasminTeles/dotfiles](https://github.com/YasminTeles/dotfiles) — distributed by [TomeVault](https://tomevault.io).