S Skillteca
Receber por email
Explorar Categorias Coleções Newsletter
← Voltar para o catálogo

crafting-effective-readmes

Segurança Autor: aiskillstore

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

367estrelas
Atualizado há 4 meses
Ver no GitHub ↗

Como adicionar

/plugin marketplace add aiskillstore/marketplace

O comando exato pode variar conforme o repositório. Confira o README no GitHub.

Para o autor da skill

Cole no README do seu repo

Mostra que sua skill está catalogada na Skillteca, gera backlink e tráfego rastreável.

[![Skillteca](https://www.skillteca.com.br/api/badge/crafting-effective-readmes/svg)](https://www.skillteca.com.br/skills/crafting-effective-readmes)

Skills relacionadas

Ver todas de Segurança →

security-research

63k

Habilidade de pesquisa de segurança em Modo Equipe que orquestra 3 caçadores de vulnerabilidades e 2 engenheiros de PoC para auditar um código, provar explorabilidade, classificar causas raiz e calibrar a severidade. É utilizada para revisão de segurança, pesquisa de vulnerabilidades, auditoria de explorabilidade e validação de modelo de ameaças.

Segurança por code-yeongyu

security-scanning-security-dependencies

41.2k

You are a security expert specializing in dependency vulnerability analysis, SBOM generation, and supply chain security. Scan project dependencies across multiple ecosystems to identify vulnerabilities, assess risks, and provide automated remediation strategies.

Segurança #ai #git por sickn33

vulnerability-scanner

41.2k

Advanced vulnerability analysis principles. OWASP 2025, Supply Chain Security, attack surface mapping, risk prioritization.

Segurança #ai #git por sickn33

dependency-management-deps-audit

41.2k

You are a dependency security expert specializing in vulnerability scanning, license compliance, and supply chain security. Analyze project dependencies for known vulnerabilities, licensing issues, outdated packages, and provide actionable remediation strategies.

Segurança #ai #git por sickn33

Alerta por categoria

Receba novas skills de Segurança toda segunda

1 email curto, só com as skills novas de Segurança. 4 minutos de leitura, sem spam, cancela com 1 clique.

Você confirma o email no primeiro envio. Sem spam. Cancela com 1 clique.

Ler descrição completa

Crafting Effective READMEs

Overview

READMEs answer questions your audience will have. Different audiences need different information - a contributor to an OSS project needs different context than future-you opening a config folder.

Always ask: Who will read this, and what do they need to know?

Process

Step 1: Identify the Task

Ask: "What README task are you working on?"

| Task | When | |------|------| | Creating | New project, no README yet | | Adding | Need to document something new | | Updating | Capabilities changed, content is stale | | Reviewing | Checking if README is still accurate |

Step 2: Task-Specific Questions

Creating initial README:

  1. What type of project? (see Project Types below)
  2. What problem does this solve in one sentence?
  3. What's the quickest path to "it works"?
  4. Anything notable to highlight?

Adding a section:

  1. What needs documenting?
  2. Where should it go in the existing structure?
  3. Who needs this info most?

Updating existing content:

  1. What changed?
  2. Read current README, identify stale sections
  3. Propose specific edits

Reviewing/refreshing:

  1. Read current README
  2. Check against actual project state (package.json, main files, etc.)
  3. Flag outdated sections
  4. Update "Last reviewed" date if present

Step 3: Always Ask

After drafting, ask: "Anything else to highlight or include that I might have missed?"

Project Types

| Type | Audience | Key Sections | Template | |------|----------|--------------|----------| | Open Source | Contributors, users worldwide | Install, Usage, Contributing, License | templates/oss.md | | Personal | Future you, portfolio viewers | What it does, Tech stack, Learnings | templates/personal.md | | Internal | Teammates, new hires | Setup, Architecture, Runbooks | templates/internal.md | | Config | Future you (confused) | What's here, Why, How to extend, Gotchas | templates/xdg-config.md |

Ask the user if unclear. Don't assume OSS defaults for everything.

Essential Sections (All Types)

Every README needs at minimum:

  1. Name - Self-explanatory title
  2. Description - What + why in 1-2 sentences
  3. Usage - How to use it (examples help)

References

  • section-checklist.md - Which sections to include by project type
  • style-guide.md - Common README mistakes and prose guidance
  • using-references.md - Guide to deeper reference materials
Compartilhar X LinkedIn