Receber por email
← Voltar para o catálogo

readme-for-developers

Write developer-oriented README as onboarding documentation. Use when creating/updating README, setting up new projects, or when new developers need to understand the codebase quickly. README = Entry point + Architecture overview + Working agreement.

2estrelas
Atualizado há 4 meses

Ver no GitHub ↗

Como adicionar

/plugin marketplace add bg-szy/TOP-SKILLS

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/readme-for-developers-bg-szy/svg)](https://www.skillteca.com.br/skills/readme-for-developers-bg-szy)

Skills relacionadas

Ver todas de Desenvolvimento →

Alerta por categoria

Receba novas skills de Desenvolvimento toda segunda

1 email curto, só com as skills novas de Desenvolvimento. 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

README for Developers

개발자를 위한 README는 마케팅 문서가 아니라 '인계인수서'입니다. 이 문서 하나만 보고도 신규 개발자가 로컬 서버를 띄우고, 코드 흐름을 머릿속에 그릴 수 있어야 합니다.

Core Principle

"README = 지도, 디테일은 docs/로 링크"
정보를 한 파일에 다 넣지 말고, README가 전체 지도를 제공하고 세부는 링크로 내려가게 한다.

README 품질 체크리스트

README만 읽고 새 개발자가 아래 질문에 답할 수 있으면 합격:

  • [ ] 이 시스템의 목표/비목표는?
  • [ ] 데이터는 어디에 저장되고, 핵심 식별자는?
  • [ ] 핵심 플로우 2~3개는 어떻게 동작하는가?
  • [ ] 엔트리포인트 파일 3개는 어디인가?
  • [ ] 자주 터지는 버그의 관측 지점은?
  • [ ] CI는 무엇을 어떤 순서로 강제하는가?
  • [ ] *

[Description truncada. Veja o README completo no GitHub.]

Compartilhar X LinkedIn