agentmods.dev

readme_file.write_architecture

readme_file.write_architecture is a skill for Claude Code from gpsaggese/helpers. It costs 7 tokens per session (812 once invoked), scanned A, original, Apache-2.0.

A documentation workflow that analyzes a Python file and writes or updates a matching README describing its architecture, public code, dependencies, and relationships between functions.

In plain words
What is it for?
Use it to document functions, classes, exported interfaces, imports, call relationships, and the file's role in a larger system.
Why use it?
It makes an unfamiliar Python module easier to understand and keeps its architecture notes alongside the source file.

Skill for Claude Code

Written for Claude Code: installed under .claude/. Also seen: model in frontmatter; reads .claude/ paths.

not rated 158repo +1 today A scan 7 tokens original Apache-2.0

Good fit Use it to document functions, classes, exported interfaces, imports, call relationships, and the file's role in a larger system.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/gpsaggese/helpers/readme_file.write_architecture
View source ↗ gpsaggese/helpers
Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Any agent
npx skills add gpsaggese/helpers --skill readme_file.write_architecture
Clone the repo
git clone --depth 1 https://github.com/gpsaggese/helpers

Made for: Claude Code.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for readme_file.write_architecture

README.md
[![agentmods](https://agentmods.dev/badge/skills/gpsaggese/helpers/readme_file.write_architecture/github.svg)](https://agentmods.dev/skills/gpsaggese/helpers/readme_file.write_architecture)
Your own site
<a href="https://agentmods.dev/skills/gpsaggese/helpers/readme_file.write_architecture"><img src="https://agentmods.dev/badge/skills/gpsaggese/helpers/readme_file.write_architecture/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for readme_file.write_architecture

Your own site · 80×15
<a href="https://agentmods.dev/skills/gpsaggese/helpers/readme_file.write_architecture"><img src="https://agentmods.dev/badge/skills/gpsaggese/helpers/readme_file.write_architecture.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 7 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 812 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00007 $0.00812
Opus 5.5 $0.00003 $0.00325
Sonnet 5.5 $0.00001 $0.00162
Haiku 4.5 $0.00001 $0.00081

Measured yesterday against content hash bf180e62f896, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

readme_file.write_architecture scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured yesterday.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.claude/skills/readme_file.write_architecture/SKILL.md · 94 lines

How it starts

The opening of the file, as written. The whole thing — 94 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Goal

  • Analyze the Python file <FILE> passed by the user, and generate or update <FILE>.README.md with bullet-point documentation of its architecture, code organization, idioms, and so on

Workflow

Read File

  • Read <FILE> to understand its structure:
    • Parse all function and class definitions
    • Identify the public API (exported functions, classes, constants)
    • Trace which functions call which
    • Identify external dependencies (imports from other modules, libraries)
    • Note the module's purpose and role in the broader system

Check the Existing Readme

  • If <FILE>.README.md exists, read it and plan what to update. Otherwise, plan the content from scratch
  • Make sure the docstring of the corresponding file points to <FILE>.README.md, e.g., 
    For a description of the architecture of this file, see the file
<FILE>.README.md

Generate Document

  • Follow the template .claude/templates/architecture_doc.template.md
  • Generate the sections in markdown with bullet points, following:
    • .claude/skills/markdown.rules.md for markdown formatting
    • .claude/skills/text.rules.md for text formatting

Update Document

  • Write the results to <FILE>.README.md in the same dir as <FILE>
  • Wrap the text at 85 columns

Conventions

  • Use conventions summarized in docs/documentation_meta/all.architecture_diagrams.explanation.md
  • Use PlantUML diagrams (```plantuml) for all architecture diagrams, never Mermaid, following .claude/skills/C4.rules.md
  • Use the standard C4 layout in PlantUML:
    • Person for external users
    • System for external systems
    • Container for application containers/processes
    • Component for internal components
    • Rel for relationships between elements
  • Label diagrams with what they show
  • Reference real code artifacts (function names, class names, file paths) when available
  • Distinguish facts from assumptions:
    • For facts (code-derived):
      • E.g., "The function process_data() calls validate_input() before computing results"
    • For assumptions:
      • E.g., "This likely handles error cases based on the try-except blocks present"
  • Focus on:
    • Maintainability: How easy is it to modify and extend this code?
    • Extensibility: How well does the design accommodate new features?
    • Operational understanding: What must someone know to work with this code?
  • Say how the doc was generated, with this line right after the title: 
    - Generated by `.claude/skills/readme_file.write_architecture/SKILL.md`

Read the full file on GitHub · 94 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. yesterday First seen · 94 lines · 7 tokens per session scan A bf180e62f896

Subscribe to this mod's changes

readme_file.write_architecture is a skill published in the GitHub repository gpsaggese/helpers (158 stars, last pushed today), licensed Apache-2.0. It adds 7 tokens to every session and 812 once invoked, about $0.0000 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-11-06.

LanguagesPythonWriting and docs
Related

readme_file.write_architecture compared with skills from other repositories

readme_file.write_architecture next to 6 skills from other repositories
ModTypeStarsLast pushLicenceScanTokensWorks with
readme_file.write_architecturegpsaggese/helpersSkill158todayApache-2.0A7Claude Code
matlabK-Dense-AI/scientific-agent-skillsSkill56k5d agoMITA44Claude Code
pennylaneK-Dense-AI/scientific-agent-skillsSkill56k5d agoMITA74Claude Code
holoscan-install-wheelNVIDIA/skillsSkill3.9ktodayApache-2.0A34Claude Code, Codex
future-self-liteTHU-MAIC/OpenMAICSkill43kyesterdayMITA20Claude Code, Codex
rocm-kernelshuggingface/kernelsSkill783yesterdayApache-2.0A93Claude Code
typing-exclusion-workergetsentry/skillsSkill1.1kyesterdayApache-2.0A57Claude Code