BeClaude

readme-writer

New
2Community RegistryGeneralby Szymon Paluch · MIT

Generate and audit perfect READMEs using the PRD-README v1 standard

Community PluginView Source

Overview

Claude Code plugins that enforce code quality practices: TDD workflows, performance analysis, and documentation standards.

![License: MIT](LICENSE) !Status: Active

What's Included

PluginVersionPurpose
tdd-dev0.2.1Enforce Red→Green→Refactor TDD cycles
n1-optimizer0.1.3Detect N+1 queries and performance issues
readme-writer0.1.0Generate/audit READMEs with PRD-README v1
doc-master0.2.19 specialized documentation agents

Quick Start

Prerequisites: Claude Code CLI installed

Step 1: Add the marketplace

bash
/plugin marketplace add hculap/better-code

Output:

code
Successfully added marketplace: better-code

Step 2: Install a plugin

bash
/plugin install tdd-dev

Output:

code
Installed plugin: tdd-dev

Step 3: Use the plugin

bash
/tdd-dev:start

Output:

code
TDD Dev Mode: ACTIVE

Configuration:
  Strictness: strict
  Test Command: npm test

That's it! You're now coding with TDD enforcement.

Usage

tdd-dev: Test-Driven Development

Enforces writing tests before implementation code.

bash
/tdd-dev:start              # Enable TDD mode
/tdd-dev:feature "add auth" # Implement feature with TDD
/tdd-dev:bug "fix #123"     # Fix bug with regression test first
/tdd-dev:refactor           # Safe refactoring verified by tests
/tdd-dev:stop               # Disable TDD mode

Strictness levels: strict (tests required), standard (tests encouraged), relaxed (minimal enforcement)

n1-optimizer: Performance Analysis

Runs 4 parallel agents to analyze your codebase for performance issues.

bash
/n1-optimizer:analyze

Output:

code
Analysis Complete

Database Layer: 3 issues found
  HIGH: N+1 query in UserService.getOrders() - src/services/user.ts:45

Backend Layer: 1 issue found
  MEDIUM: Sequential awaits could be parallelized - src/api/reports.ts:23

Frontend Layer: 2 issues found
  HIGH: Missing React.memo on ExpensiveList - src/components/List.tsx:12

API Layer: 1 issue found
  MEDIUM: Missing pagination on /api/products - src/routes/products.ts:8
AgentDetects
DatabaseN+1 queries, missing indexes, unbatched writes
BackendO(n²) algorithms, blocking I/O, memory issues
FrontendRe-render loops, large bundles, missing memoization
APIOver-fetching, missing pagination, chatty endpoints

readme-writer: README Generation

Generate or audit READMEs following the PRD-README v1 standard.

bash
/readme-writer:generate      # Generate README from codebase analysis
/readme-writer:audit         # Score existing README (0-10)

Audit output:

code
README Audit Score: 7/10

✓ Test 1: What is it? - PASS
✓ Test 2: Is it maintained? - PASS
✗ Test 3: Quickstart works - FAIL (missing expected output)
...

doc-master: Documentation Toolkit

9 specialized agents for comprehensive documentation.

bash
/doc-master:setup            # Choose framework (Diátaxis/Traditional/Custom)
/doc-master:generate "API"   # Generate API documentation
/doc-master:audit            # Audit existing docs
/doc-master:plan             # Create documentation plan
AgentFocus
api-docsREST/GraphQL endpoints, schemas
backend-docsServices, data flows, deployment
frontend-docsComponents, state management
database-docsSchema, migrations, ER diagrams
architecture-docsSystem design, ADRs
test-docsTest strategy, coverage
user-guide-docsTutorials, help articles
compliance-docsSecurity, audit, regulatory
mobile-docsiOS/Android, app stores

Documentation

Full documentation available in docs/:

Contributing

Contributions welcome! Please open an issue first to discuss proposed changes.

Quick steps:

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Open a pull request

See individual plugin READMEs for plugin-specific guidance.

Support

When reporting bugs, include:

  • Plugin name and version
  • Claude Code version
  • Steps to reproduce
  • Expected vs actual behavior

Security

To report security vulnerabilities, please email the maintainer directly rather than opening a public issue.

License

MIT License - see LICENSE for details.

Copyright (c) 2024 Szymon Paluch

Install & Usage

1
Create the skills directory
mkdir -p .claude/skills
2
Download the skill file
mkdir -p .claude/skills && curl -o .claude/skills/readme-writer.md https://raw.githubusercontent.com/hculap/better-code/main/SKILL.md
3
Invoke in Claude Code
/readme-writer
View source on GitHub
readmedocumentationprd-readmedeveloper-experience

Frequently Asked Questions

What is readme-writer?

Generate and audit perfect READMEs using the PRD-README v1 standard

How to install readme-writer?

To install readme-writer, create the .claude/skills directory in your project, then run the curl command to download the skill file. Once installed, invoke it in Claude Code with /readme-writer.

What is readme-writer best for?

readme-writer is a community categorized under General. It is designed for: readme, documentation, prd-readme, developer-experience. Created by Szymon Paluch.