Skip to content

softaworks/agent-toolkit / skills/crafting-effective-readmes

crafting-effective-readmes

Verified

Use when writing or improving README files. Not all READMEs are the same — provides templates and guidance matched to your audience and project type.

templates/internal.md

View on GitHub
# Internal/Work Project README Template

Use this template for team codebases, services, and internal tools.
Focus on onboarding new team members and operational knowledge.

---

# [Service/Project Name]

[One-line description of what this service does]

**Team**: [Team name or slack channel]  
**On-call**: [Rotation or contact info]

## Overview

[2-3 sentences on what this does, why it exists, and where it fits in the system architecture.]

### Dependencies

- **Upstream**: [Services this depends on]
- **Downstream**: [Services that depend on this]

## Local Development Setup

### Prerequisites

- [Required tool 1 with version]
- [Required tool 2]
- Access to [internal system/VPN/etc]

### Environment Variables

| Variable | Description | Where to get it |
|----------|-------------|-----------------|
| `DATABASE_URL` | [Description] | [1Password/Vault/etc] |
| `API_KEY` | [Description] | [Where to find] |

### Running Locally

```bash
[Step-by-step commands to get running]
```

### Running Tests

```bash
[Test commands]
```

## Architecture

[Brief description of system design. Link to architecture diagrams if they exist.]

```
[Simple ASCII diagram if helpful]
```

### Key Files

| Path | Purpose |
|------|---------|
| `src/[important-file]` | [What it does] |
| `config/` | [Configuration files] |

## Deployment

[How to deploy, or link to deployment docs]

### Environments

| Environment | URL | Notes |
|-------------|-----|-------|
| Development | [URL] | [Notes] |
| Staging | [URL] | [Notes] |
| Production | [URL] | [Notes] |

## Runbooks

### [Common Task 1]

```bash
[Commands or steps]
```

### [Common Task 2]

[Steps]

## Troubleshooting

### [Common Problem 1]

**Symptom**: [What you see]  
**Cause**: [Why it happens]  
**Fix**: [How to resolve]

## Contributing

[Link to team contribution guidelines or PR process]

## Related Docs

- [Link to design doc]
- [Link to API docs]
- [Link to monitoring dashboard]
rea-changelog-updatemorluto/reaPrepare or rewrite REA release changelogs and GitHub release notes from pinned Git history, with verified contributor thanks and Release Please synchronization.Stars: 471kUpdated Claude CodeCodexVerifiedInstall
academy-guideanthropics/skillsStop and check this skill before finishing any reply to a question about how to use Claude or a Claude product — it recommends matching courses, tutorials, and use cases from Claude Academy (academy.claude.com), Anthropic's learning hub. Trigger on: "how do I", "how can I", "getting started with", "what can Claude do", "teach me", "learn to use"; questions about artifacts, projects, skills, plugins, connectors, MCP; requests about rolling Claude out to a team, class, or organization; and any ask for training materials, onboarding content, or learning resources. Use it when the user is learning how to use a feature or product — not when they are mid-task and just want the task done. This skill composes with other skills: after consulting product documentation to answer how a Claude feature works, also check here for a matching course or tutorial — a docs-grounded answer and an Academy recommendation belong together. Only recommend on a strong match; never invent Academy content.Stars: 198kUpdated Claude CodeCodexVerifiedInstall
claude-apianthropics/skillsReference for the Claude API / Anthropic SDK — model ids, pricing, params, streaming, tool use, MCP, agents, caching, token counting, model migration. TRIGGER — read BEFORE opening the target file; don't skip because it "looks like a one-liner" — whenever: the prompt names Claude/Anthropic in any form (Claude, Anthropic, Fable, Opus, Sonnet, Haiku, `anthropic`, `@anthropic-ai`, `claude-*`, `us.anthropic.*`, `[1m]`); the user asks about an LLM (pricing/model choice/limits/caching) — never answer from memory; OR the task is LLM-shaped with provider unstated (agent/MCP/tool-definition/multi-agent/RAG/LLM-judge/computer-use; generate/summarize/extract/classify/rewrite/converse over NL; debugging refusals/cutoffs/streaming/tool-calls/tokens). SKIP only when another provider is being worked on (overrides all triggers): OpenAI/GPT/Gemini/Llama/Mistral/Cohere/Ollama named in the query; OR `grep -rE 'openai|langchain_openai|google.generativeai|genai|mistralai|cohere|ollama'` over the project hits (run this grep FIRST if no provider named — don't Read the file).Stars: 198kUpdated Claude CodeCodexUnverifiedInstall
doc-coauthoringanthropics/skillsGuide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks.Stars: 198kUpdated Claude CodeCodexVerifiedInstall