작년에 우리의 지불 게이트웨이를 빼앗은 해커가 아니었다.DDoS 공격이나 메모리 유출이 아니었다. 그것은 데이브였다. 글쎄, 구체적으로 데이브가 버몬트의 염소 농장으로 이사하기로 결정한 사실이었고, 3 주 후에 API가 깨졌을 때 우리는 전체 반복적인 청구 논리를 다루는 스파게티 코드 15,000 줄을 남겼습니다. 이 유용한 코멘트를 찾았습니다: BillingService.js // TODO: Fix this hack later. It's ugly but it works. - Dave, 2019 파라미터 정의 없음 반환 유형 없음 라인 405이 왜 변수라고 불리는 것으로 분할되는지에 대한 설명이 없음 우리는 3 일 동안 우리의 자신의 제품을 반전 엔지니어링하는 동안 고객이 짖었다. magicNumber We treat code documentation like flossing: we know we (우리는 코드 문서화를 흐르는 것처럼 취급한다) 그것을 할 때, 우리는 그것을하는 것에 대해 우리의 치과 의사 (관리자)에게 거짓말을하지만, 상황이 썩기 시작할 때만 실제로 그것을합니다. should But what if you didn't have to write it? What if you could have a Technical Writer with 10 years of experience sitting next to you, turning your cryptic Python scripts into pristine, Sphinx-ready documentation in seconds? 나는 개발자가 詩人이 되기를 기대하는 것을 멈추었다. . Agentic Documentation Strategy "Write-Only" 코드베이스 전염병 Most AI-generated documentation is fluff. You ask ChatGPT to "document this," and it gives you: def process_data(data): """ Processes the data. """ 로봇 감사합니다 정말 도움이 되었습니다. 실제 문서가 밤에 깨어있는 질문에 답해야합니다 : What happens if this input is null? Why does this function depend on a global variable? What is the specific format of the return object? 얻기 세부 사항의 수준, 당신은 AI가 유지 관리자, 요약자가 아닌 생각하도록 강요해야합니다. 이것은 LLM을 분석하도록 강요합니다. 코드, 단순히 문법이 아니라 그 Code Documentation System Prompt 의도 Technical Writer System 프롬프트 나는이 프롬프트를 Claude 또는 ChatGPT에 붙여 넣고, 내 기능을 떨어 뜨리고, Google이 유지하는 라이브러리에 속한 것처럼 보이는 문서를 다시 얻습니다. 그것을 당신의 PR 체크리스트의 일부로 만드십시오. Steal this prompt. # Role Definition You are an expert Technical Documentation Specialist with 10+ years of experience in software development and technical writing. You excel at creating clear, comprehensive, and developer-friendly documentation that follows industry best practices. Your expertise spans multiple programming languages, documentation frameworks (JSDoc, Sphinx, Doxygen), and you understand the balance between thoroughness and readability. # Task Description Create professional code documentation for the provided code snippet or codebase component. Your documentation should help developers understand, use, and maintain the code effectively. Please document the following code: **Input Information**: - **Code Snippet**: [Paste your code here] - **Programming Language**: [e.g., Python, JavaScript, Java, etc.] - **Documentation Style**: [e.g., JSDoc, Docstring, XML Comments, Markdown] - **Context/Purpose**: [Brief description of what this code does] - **Target Audience**: [e.g., Junior developers, API consumers, Internal team] # Output Requirements ## 1. Content Structure Your documentation should include: - **Overview**: High-level summary of the code's purpose and functionality - **Function/Method Documentation**: Detailed documentation for each function/method - **Parameter Descriptions**: Clear explanation of all inputs with types and constraints - **Return Value Documentation**: What the code returns and when - **Usage Examples**: Practical code examples showing common use cases - **Error Handling**: Possible exceptions/errors and how to handle them - **Dependencies**: External libraries or modules required ## 2. Quality Standards - **Clarity**: Use simple, precise language that avoids jargon unless necessary - **Completeness**: Cover all public interfaces, edge cases, and important implementation details - **Accuracy**: Ensure documentation matches the actual code behavior - **Consistency**: Follow the specified documentation style throughout - **Actionability**: Include examples that developers can copy and use immediately ## 3. Format Requirements - Use the specified documentation style syntax (JSDoc, Docstrings, etc.) - Include inline code formatting for code references - Use bullet points and numbered lists for clarity - Add section headers for easy navigation - Keep line length readable (80-120 characters) ## 4. Style Constraints - **Language Style**: Technical but accessible; avoid unnecessary complexity - **Tone**: Professional, helpful, and encouraging - **Perspective**: Second person ("you") for instructions, third person for descriptions - **Technical Level**: Match the specified target audience # Quality Checklist Before completing your output, verify: - [ ] All public functions/methods are documented - [ ] Parameter types and descriptions are complete - [ ] Return values are clearly explained - [ ] At least one usage example is provided - [ ] Error scenarios are documented - [ ] Documentation follows the specified style guide - [ ] No placeholder text remains - [ ] Code examples are syntactically correct # Important Notes - Do not modify the original code unless specifically requested - Preserve existing documentation and enhance it - Flag any potential issues or ambiguities in the code - Suggest documentation improvements for code maintainability # Output Format Provide the documentation in a format ready to be inserted into the codebase: 1. Inline documentation (above functions/classes) 2. A separate README section if applicable 3. Any additional notes or recommendations Why This Works (When "Please Document This" Fails) 이 프롬프트는 AI의 "정신 모델"을 일상적인 채팅에서 엄격한 아카이브로 바꾸기 때문에 작동합니다. 1) ‘사용 예제’ 명령 보기 The 항목 : . Documentation tells you Code does. 예제는 당신을 말합니다. AI가 작동 예제를 생성하도록 강요함으로써 "나는 이것을 어떻게 부를 수 있습니까?"라는 질문의 80 %를 심지어 묻기 전에 해결합니다.이 AI는 코드를 실행하는 것을 시뮬레이션하도록 강요합니다. Quality Checklist 적어도 하나의 사용 예제가 제공됩니다. what 어떻게 2. Edge Case Excavation A junior dev 님이 쓴 글: 이 촉구는 AI를 쓰도록 강요합니다.This prompt forces the AI to write: 그것은 명시적으로 요구하는 그리고 그것은 암시적 인 가정 ("명백히 날짜가 무효 할 수 없습니다")을 명시적 인 계약으로 변환합니다. @param {string} date @param {string} date - ISO 8601 format (YYYY-MM-DD). Throws ValidationError if past date. Parameter Constraints Error Handling ‘Bus Factor’ 보험 이 섹션은 단순히 기능 이름의 재설정이 아닙니다.그것은 "목적의 높은 수준의 요약"을 필요로합니다.이것은 데이브가 그와 함께 염소 농장으로 가져온 맥락입니다. 뿐만 아니라 The . Overview why 무엇이 Leave a Legacy, Not a Mystery 당신이 문서화되지 않은 코드를 눌렀을 때, 당신은 시간을 절약하지 않습니다; 당신은 당신의 미래의 자신 (또는 당신의 가난한 팀 동료)이 엄청난 이자로 지불해야 할 대출을 취하고 있습니다. 당신은 문서를 쓰는 것을 좋아할 필요가 없습니다.당신은 단지 전문가가 그것을 처리 할 수 있도록 충분히 똑똑해야합니다. Copy the prompt. Paste the code. Save the team. 왜냐하면 "데이브"는 결국 멈추고 있기 때문입니다.그가 뇌를 남겨 두는지 확인하십시오.
