AgentSkillsCN

progress-doc

为功能分支创建并维护实施进度文档

SKILL.md
--- frontmatter
name: progress-doc
description: Create and maintain implementation progress documentation for a feature branch

Progress Documentation

Create and maintain a progress document in docs/progress/{branch-name}.md to track implementation status.

File Location

code
docs/progress/{branch-name}.md

Example: docs/progress/feat-STU-15-user-authentication.md

Note: Replace / in branch names with - for the filename.

Document Structure

markdown
# {Ticket ID}: {Ticket Title}

**Branch:** `{branch-name}`
**Status:** {In Progress | Blocked | Complete}
**Started:** {YYYY-MM-DD}
**Last Updated:** {YYYY-MM-DD HH:MM}

## Overview

{Brief description of what this ticket implements}

## Tasks

- [ ] Task 1
- [ ] Task 2
- [x] Completed task

## Progress Log

### {YYYY-MM-DD HH:MM}

{Description of work done}

### {YYYY-MM-DD HH:MM}

{Description of work done}

## Technical Notes

{Any important technical decisions, gotchas, or context for future reference}

## Blockers

{Any blockers or dependencies - remove section if none}

## Testing

- [ ] Unit tests written
- [ ] Integration tests written
- [ ] Manual testing completed

## Files Changed

- `path/to/file1.ts` - {brief description}
- `path/to/file2.ts` - {brief description}

Steps

Creating New Progress Doc

  1. •

    Ensure directory exists:

    bash
    mkdir -p docs/progress
  2. •

    Get branch name:

    bash
    git branch --show-current
  3. •

    Create the file with the initial template filled in

Updating Progress Doc

  1. •Read current content of the progress doc
  2. •Add new entry to Progress Log with timestamp
  3. •Update:
    • •Status if changed
    • •Last Updated timestamp
    • •Task checkboxes
    • •Files Changed list
    • •Technical Notes as needed

When to Update

Update the progress document:

  • •When starting a new task
  • •After completing a significant piece of work
  • •When encountering blockers
  • •When making important technical decisions
  • •Before committing changes

Example

markdown
# STU-15: Add User Authentication

**Branch:** `feat/STU-15-user-authentication`
**Status:** In Progress
**Started:** 2024-01-15
**Last Updated:** 2024-01-15 14:30

## Overview

Implement JWT-based authentication with login, logout, and token refresh.

## Tasks

- [x] Set up JWT utilities
- [x] Create auth middleware
- [ ] Implement login endpoint
- [ ] Implement logout endpoint
- [ ] Add refresh token logic
- [ ] Write integration tests

## Progress Log

### 2024-01-15 14:30

Completed JWT utilities and auth middleware. Moving on to login endpoint.

### 2024-01-15 10:00

Started implementation. Set up project structure for auth module.

## Technical Notes

- Using RS256 algorithm for JWT signing
- Refresh tokens stored in httpOnly cookies
- Access token expiry: 15 minutes

## Files Changed

- `api/src/utils/jwt.ts` - JWT sign/verify utilities
- `api/src/middleware/auth.ts` - Authentication middleware
- `api/src/types/auth.ts` - TypeScript interfaces