scribe

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.

16 stars

Best use case

scribe is best used when you need a repeatable AI agent workflow instead of a one-off prompt.

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.

Teams using scribe should expect a more consistent output, faster repeated execution, less prompt rewriting.

When to use this skill

  • You want a reusable workflow that can be run more than once with consistent structure.

When not to use this skill

  • You only need a quick one-off answer and do not need a reusable workflow.
  • You cannot install or maintain the underlying files, dependencies, or repository context.

Installation

Claude Code / Cursor / Codex

$curl -o ~/.claude/skills/scribe/SKILL.md --create-dirs "https://raw.githubusercontent.com/diegosouzapw/awesome-omni-skill/main/skills/testing-security/scribe/SKILL.md"

Manual Installation

  1. Download SKILL.md from GitHub
  2. Place it in .claude/skills/scribe/SKILL.md inside your project
  3. Restart your AI agent — it will auto-discover the skill

How scribe Compares

Feature / AgentscribeStandard Approach
Platform SupportNot specifiedLimited / Varies
Context Awareness High Baseline
Installation ComplexityUnknownN/A

Frequently Asked Questions

What does this skill do?

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.

Where can I find the source code?

You can find the source code on GitHub using the link provided at the top of the page.

SKILL.md Source

# 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>

Related Skills

parametric-scribe

16
from diegosouzapw/awesome-omni-skill

Enables "Time Machine" coding. Records tasks as a Recipe and allows intelligent replay/modification of history.

happy-scribe-automation

16
from diegosouzapw/awesome-omni-skill

Automate Happy Scribe tasks via Rube MCP (Composio). Always search tools first for current schemas.

audio-transcriber

16
from diegosouzapw/awesome-omni-skill

Transform audio recordings into professional Markdown documentation with intelligent summaries using LLM integration

bgo

16
from diegosouzapw/awesome-omni-skill

Automated Blender build-go workflow. Automatically builds, removes old version, installs, enables, and launches Blender with your extension/add-on. Use when you want to quickly test changes, execute complete build-to-launch cycle, or run custom packaging scripts with automatic Blender launch.

Coding & Development

jj-workflow

16
from diegosouzapw/awesome-omni-skill

Jujutsu atomic workflow with full operational reference for jj-based repositories.

jj-vcs-workflow

16
from diegosouzapw/awesome-omni-skill

Jujutsu (jj) VCS の総合ガイド。基本コマンド・Git移行・並列開発・履歴操作・PRレビュー・安全な push ワークフローをカバー。以下の場合に使用: (1) jj コマンドの使い方を確認したいとき (2) Git から jj への移行時 (3) 並列開発・履歴書き換え・コンフリクト解消を行うとき (4) PR レビュー対応時 (5) push を実行したいとき

jenkinsfile-validator

16
from diegosouzapw/awesome-omni-skill

Comprehensive toolkit for validating, linting, testing, and automating Jenkinsfile pipelines (both Declarative and Scripted). Use this skill when working with Jenkins pipeline files, validating pipeline syntax, checking best practices, debugging pipeline issues, or working with custom plugins.

jarvis-autonomous

16
from diegosouzapw/awesome-omni-skill

Fully autonomous AI agent with self-improvement, GitHub automation, and Telegram control. Creates projects, learns continuously, and manages itself proactively.

iterm-worktree

16
from diegosouzapw/awesome-omni-skill

Manage git worktrees with iTerm2 integration. Use when user asks to create isolated development environments, work on features in parallel, manage worktrees, open worktrees in new tabs/windows, switch between worktrees, or close completed worktrees. Triggers on "create worktree", "new worktree", "feature branch with worktree", "open worktree", "switch worktree", "close worktree", "list worktrees", or mentions wanting to work on multiple features simultaneously.

iterate-pr

16
from diegosouzapw/awesome-omni-skill

Iterate on a PR until CI passes. Use when you need to fix CI failures, address review feedback, or continuously push fixes until all checks are green. Automates the feedback-fix-push-wait cycle.

ipinfo-io-automation

16
from diegosouzapw/awesome-omni-skill

Automate Ipinfo IO tasks via Rube MCP (Composio). Always search tools first for current schemas.

ip2whois-automation

16
from diegosouzapw/awesome-omni-skill

Automate Ip2whois tasks via Rube MCP (Composio). Always search tools first for current schemas.