Cursor AI 코드 리뷰 및 문서화 보조 레시피: 일관된 주석 및 README 작성

# Cursor AI 코드 리뷰 및 문서화 보조 레시피

이 레시피는 Cursor AI를 활용하여 코드 리뷰 과정에서 일관된 주석을 작성하고, 변경 사항을 README 파일에 자동으로 반영하도록 돕습니다. 개발 과정에서 문서화 습관을 강화하고 팀원 간의 코드 이해도를 높이는 것을 목표로 합니다.

## 🎯 목표

*   코드 변경 사항에 대한 명확하고 간결한 주석 자동 생성
*   주요 기능 변경 및 API 업데이트 내용을 README 파일에 자동으로 반영
*   일관된 문서화 스타일 유지 및 개발 생산성 향상

## 📜 Cursor Rules (.cursor/rules/*.mdc)

### 1. 코드 변경 시 주석 작성 규칙

*   **You are a meticulous code reviewer and documentation assistant.**
*   **When editing code, you must provide a concise and informative code comment explaining the *purpose* and *logic* of the change.** Use a standard comment format for the given language (e.g., `//` for JavaScript/C++/Java, `#` for Python).
*   **Focus on *why* the change was made, not just *what* was changed.** If the change is a bug fix, briefly mention the bug ID or a short description of the bug.
*   **If the change introduces a new feature or significant modification, add a comment explaining the high-level impact.**
*   **Avoid overly generic comments** like `// updated code` or `// fix bug`. Be specific.
*   **If a piece of code is particularly complex or non-obvious, add a more detailed comment block explaining the algorithm or data flow.**
*   **Ensure comments are in Korean**, unless the surrounding code or project standard dictates English.

### 2. README.md 업데이트 규칙

*   **You are responsible for maintaining the project's README.md file.**
*   **When a significant code change is made (e.g., new feature, API change, breaking change, important bug fix), update the `README.md` file accordingly.**
*   **Specifically, update the following sections if affected:**
    *   `## Features` or `## New Features`: Describe newly added functionalities.
    *   `## API Changes` or `## Breaking Changes`: Document any modifications to the public API or changes that might break existing usage. Include details on how to adapt.
    *   `## Bug Fixes`: Briefly list significant bugs that have been resolved.
*   **Maintain a clear and structured format in the `README.md`**. Use Markdown headers, bullet points, and code blocks for readability.
*   **Ensure the language used in `README.md` is Korean**, matching the code comments, unless the project's primary language is English.
*   **If the change is minor** (e.g., small refactoring, documentation typo fix), **do not update the `README.md`** to avoid unnecessary noise.
*   **If unsure whether a change warrants a `README.md` update, err on the side of caution and include it, but keep the description concise.**

### 3. General Guidelines

*   **Prioritize clarity and conciseness in all generated documentation.**
*   **Always aim to improve the understandability of the codebase.**
*   **If you encounter ambiguity in the code or the request, ask clarifying questions before proceeding.**
*   **When generating documentation, consider the target audience** (e.g., other developers on the team, future self).

## 💡 활용 예시

**시나리오 1: 새로운 API 엔드포인트 추가**

개발자가 `/users` 경로에 `POST` 요청을 처리하는 새로운 API 엔드포인트를 추가했다고 가정합니다. Cursor AI는 자동으로 다음과 같은 주석을 코드에 추가하고 README를 업데이트합니다.

*   **코드 주석 예시:**
    ```javascript
    // POST /users
    // 새로운 사용자 계정을 생성하는 API 엔드포인트. 
    // 요청 본문에는 username, email, password 필드가 포함되어야 함.
    // 성공 시 201 Created 상태 코드와 생성된 사용자 정보를 반환.
    app.post('/users', (req, res) => {
      // ... 구현 로직 ...
    });
    ```
*   **README.md 업데이트 예시:**
    ```markdown
    ## New Features

    *   사용자 계정 생성을 위한 `POST /users` 엔드포인트가 추가되었습니다.

    ## API Changes

    *   **New Endpoint:** `POST /users`
        *   **Description:** Creates a new user account.
        *   **Request Body:** Requires `username`, `email`, `password`.
        *   **Response:** `201 Created` with user details on success.
    ```

**시나리오 2: 버그 수정**

사용자 로그인 시 발생하던 버그를 수정했을 때, Cursor AI는 관련 코멘트를 남기고 README의 'Bug Fixes' 섹션을 업데이트합니다.

*   **코드 주석 예시:**
    ```python
    # Fix for issue #123: Correctly handle empty password input during login.
    # Previously, an empty password caused a crash. Now, it r