Technical Writing for Security Audit Reports

VerifiedSafe

Writes formal security audit report content: generates detailed issue write-ups (context, impact, recommendation) and system overview / security model sections. Helps security auditors produce polished, consistent reports.

Sby Skills Guide Bot
SecurityIntermediate
6/2/2026
Claude Code
#technical-writing#security-audit#audit-report#security-findings

Recommended for

Automated summary

Generates formal security audit reports, including writing audit findings and system overview/security model sections.

Strengths

  • Produces well-structured reports following industry standards
  • Automatically includes code references with commit hashes
  • Adjusts length and detail based on issue severity

Limitations

  • Requires good understanding of the context from the user for technical details
  • Does not handle full multi-section reports beyond the described sections
  • Depends on Git tools and source code access for permalinks
When to use it

Use this skill to write formal security audit reports, either for individual findings or complete system overview and security model sections.

When not to use it

Avoid using it for non-security documentation or when the source code is not accessible via Git.

Security analysis

Safe
Quality score92/100

The skill exclusively uses read-only tools (Read, Glob, Grep) and safe Bash commands limited to git rev-parse and git remote, which are non-destructive and only gather repository metadata for permalink construction. There are no destructive or exfiltrating instructions.

No concerns found

How this analysis is made

Examples

Write a security finding
Write a formal audit issue for a reentrancy vulnerability in the withdraw function. Context: the contract is an ERC-20 token with a withdraw function that sends ether before updating the balance. The severity is High.
Generate system overview and security model
Generate the System Overview and Security Model sections for an audit report of a DeFi protocol. The protocol has three main components: a staking pool, a governance contract, and a reward distributor.

name: scribe description: Technical writing for formal security audit reports. Use when the user wants to write up a security finding, create a formal issue report, or draft system overview and security model sections for an audit report. argument-hint: "<issue details>" allowed-tools:

  • Read
  • Glob
  • Grep
  • Bash(git rev-parse*)
  • Bash(git remote*)

Scribe

<style_guide>

Style Guide

  • Tone: Technical, objective, impersonal (No "I", "we", "you").
  • Language: Simple, direct, avoiding fancy words.
  • Punctuation: Avoid em dashes. They signal AI-generated text. Prefer linear sentences with minimal punctuation and use commas or parentheses otherwise.
  • Code: Never include full code block snippets unless explicitly instructed. Use inline code for principal elements (component names, key functions) to establish context. When describing flows or logic, prefer natural language over flooding the text with code references (e.g., "the function then validates the caller's balance" over "the function then calls _validateCallerBalance").
  • Lists: Blank line before the first item for proper rendering. No blank lines between items to avoid visual gaps.
  • Standards: Write standard references with a hyphen (e.g., ERC-20, EIP-1559, not ERC20). </style_guide>

<capability_instructions>

Capabilities

<issue_instructions>

Issue

TRIGGER: User requests a formal audit issue write-up.

Goal: Generate a formal audit issue write-up.

Rules:

  1. Headline: Start with a single Markdown ### Title in Title Case. No further sub-headings in the body.
  2. Efficiency:
    • Standard: 2 to 4 paragraphs (Context -> Issue -> Recommendation).
    • Trivial/Low: Keep it concise. 2-3 sentences covering the issue and recommendation is acceptable for straightforward issues. Avoid verbosity for simple things.
    • High/Critical: Do not miss details.
    • Flows: When reasoning through a specific flow is required to understand the issue, use a numbered list to walk through the steps. This applies to attack sequences, failure modes, or any multi-step logic.
  3. Style:
    • Natural Language: Follow the Style Guide's Code rule. Describe logic in natural language. Only use inline code when natural language would be awkward or imprecise.
    • Severity Consistency: Avoid words that imply a different severity than assigned. Do not call a High issue "critical" or a Medium issue "minor".
    • Permalinks: Use Markdown links with the exact commit hash for code references.
      • Run git rev-parse HEAD to get the hash.
      • Format: [Context](https://github.com/.../blob/<commit>/<path>#L<line>).
      • Avoid line number references in prose (e.g., "on line 42"). Use the code element or description as the link text instead.
      • Do not link redundantly.
  4. Recommendation: The recommendation paragraph SHOULD contain the word "Consider".
  5. Formatting: Ensure strict adherence to Markdown lists and headers.

Instructions: Generate the write-up for the provided issue content following these rules exactly. First find the commit hash, then write. </issue_instructions>


<intro_instructions>

Intro

TRIGGER: User requests System Overview and Security Model sections for an audit report.

Goal: Write "System Overview" and "Security Model" sections for an audit report.

Output Structure:

  1. ## System Overview

    • High-level paragraph explaining the system's purpose.
    • Component Subsections (### ComponentName) for separate parts (modules, services, packages).
    • Describe role, architecture, and interactions.
    • Use bullet points for key functionalities.
    • Keep language conceptual; avoid deep jargon/code references.
  2. ## Security Model and Trust Assumptions

    • Brief intro paragraph summarizing security approach.
    • Bulleted List of Critical Trust Assumptions (The most important part!):
      • Actor Honesty: Trust in privileged roles/validators.
      • External Data Integrity: External data sources, third-party services.
      • Secure Runtime: Operational security assumptions.
      • Scope of Responsibility: What the system is not responsible for.
    • Integrate Privileged Roles description here or in a subsection.

Instructions: Generate these sections based on the provided system context. </intro_instructions> </capability_instructions>

From the file to a first result

The download contains exactly the content displayed on this page. This copy may differ from the latest version in the source repository.

View the source and supporting files

This download contains SKILL.md only. Any scripts, references, templates and dependencies are not included. Get the required files from the source, preserving their directory structure, before continuing.

1. Download the file

Download SKILL.md

From the root of a test project, save the file as .skill-downloads/technical-writing-for-security-audit-reports-mm78nnn6/SKILL.md, or use the command below. This folder is for inspecting the skill before installation.

Command for macOS/Linux or WSL: requires a POSIX shell and curl. On Windows without WSL, use the download button and create the folder manually.

mkdir -p '.skill-downloads/technical-writing-for-security-audit-reports-mm78nnn6' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/technical-writing-for-security-audit-reports-mm78nnn6/download' --output '.skill-downloads/technical-writing-for-security-audit-reports-mm78nnn6/SKILL.md.part' && mv '.skill-downloads/technical-writing-for-security-audit-reports-mm78nnn6/SKILL.md.part' '.skill-downloads/technical-writing-for-security-audit-reports-mm78nnn6/SKILL.md'

2. Check prerequisites

Read SKILL.md before using it. If it references scripts or external services, inspect them and prepare the required access in your test environment.

No recognized prerequisites section in this file. This does not mean it is self-contained: libraries, tools and access requirements may be mentioned elsewhere in the content or source repository.

The platforms on this page are catalog indications. The paths below follow tool documentation; they do not prove this skill has been run in those tools. No minimum tool version is confirmed for this listing.

3. Load the skill

After inspection, copy the complete folder into your project using one of the commands below, then open a new tool session. The command stops if a folder with the same name already exists: compare the files before replacing it.

Claude Code
test -f '.skill-downloads/technical-writing-for-security-audit-reports-mm78nnn6/SKILL.md' && test -s '.skill-downloads/technical-writing-for-security-audit-reports-mm78nnn6/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/scribe' && cp -R '.skill-downloads/technical-writing-for-security-audit-reports-mm78nnn6' '.claude/skills/scribe'

OpenSkills

OpenSkills must already be installed. The local install/read procedure is checked with OpenSkills 1.5.0, which requires Node.js ≥ 20.6.0. Catalog slugs are not resolved automatically.

Official OpenSkills installation
openskills install './.skill-downloads/technical-writing-for-security-audit-reports-mm78nnn6'

openskills read 'technical-writing-for-security-audit-reports-mm78nnn6'

Reading should display the installed file content and its base directory. It does not run the skill or install its dependencies.

For an agent that reads AGENTS.md, then sync the index. This command changes AGENTS.md: review the diff before using it.

openskills sync

Manual method or another tool: attach SKILL.md to a conversation, or open it in an agent that can read files. Include any required supporting resources. No universal folder is recognized by every tool.

4. Try a first task

Use a short, synthetic input: an API endpoint, a small document or an interface brief. In a new conversation, attach the file or give the agent its path, then adapt this request:

Read .skill-downloads/technical-writing-for-security-audit-reports-mm78nnn6/SKILL.md and apply its instructions to this example: [describe a test input]. Identify any missing files, dependencies or access. Produce the result requested by the skill without inventing data or running unreviewed scripts.

Expected result: output matching the skill instructions, or a precise list of missing prerequisites. A read confirmation alone does not validate a first use. If an external resource is unavailable, that path remains untested.

Related skills