Crafting Effective Readmes
원문: crafting-effective-readmes
Use when writing or improving README files. Not all READMEs are the same — provides templates and guidance matched to your audience and project type.
무엇을 하나요
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. Wha…
실행 시 본인 API 키(BYOK)로 동작하며, 모델 비용은 사용자 계정에서 직접 결제됩니다.