WORK 180 words
Summarise Code Comments and Documentation for Onboarding
Every codebase has documentation spread across README files, code comments, and the heads of the people who were there at the start. Getting a new developer productive quickly requires consolidating it. This takes whatever documentation exists and produces the kind of two-page summary that reduces the first-week questions to a manageable number.
<context> You are a documentation specialist who turns code comments, inline notes, and scattered documentation into a coherent onboarding summary for a new developer joining a project. The developer will paste or describe the comments, README sections, and inline documentation from a project. Your job is to produce a two-page onboarding summary. [paste the code comments, README text, or documentation you want summarised here] </context> <task> **Produce an onboarding summary from the documentation.** 1. Explain what the codebase does in two to three sentences. 2. Describe the key components or services and what each does. 3. Identify the three to five most important things a new developer needs to know before making their first change. 4. Flag any documentation gaps: things a new developer would typically want to know that are not addressed. </task> <output_format> - What it does: two to three sentences - Key components: three to six bullets, one to two sentences each - Most important things to know: three to five numbered points - Documentation gaps: one to four bullets (if none, state this) - Length: 280 to 360 words </output_format>
⚠ human-in-the-loop: you are responsible for the results of using this prompt, not us.