Skip to content

normdist-ai/devlog

Repository files navigation

Dev-Log Skill

License: MIT Type: SKILL Version: 2.1.1

中文文档 | English

An intelligent development work log management skill based on the AgentSkills specification. It guides agents to automatically record development work, track IDE usage, generate statistical analysis reports, and help users accumulate development knowledge and experience.

Overview

This skill follows the AgentSkills open standard and is fully compatible with OpenClaw platform, as well as mainstream IDEs like Trae, Cursor, VS Code, Claude Code, etc. When triggered, the agent reads skill instructions and systematically manages development logs following the workflow: collect information → detect IDE → classify work → generate log → update index → update statistics.

🚀 Quick Reference Guide

Workflow Diagram

graph TB
    A[User Request] --> B[Collect Information]
    B --> C{IDE Detection}
    C --> D[Classify Work]
    D --> E[Generate Log File]
    E --> F[Update Index]
    F --> G[Update Statistics]
    G --> H[Complete]
    
    style B fill:#e1f5ff
    style D fill:#fff4e1
    style E fill:#ffe1f5
    style F fill:#e1ffe1
Loading

Core Functions Quick Reference

Function Description Output
Auto-create Log Detect development activities and record .devlog/dev-logs/yyyy-MM-dd.md
Smart IDE Detection Environment variable/process/config file detection IDE identifier
Work Classification Automatic classification based on keywords Work type code
Version Tracking Multi-source version number detection Version changes
Statistical Analysis Multi-dimensional data statistics Analysis report

Compatibility

Supported IDEs

This skill is fully compatible with the following IDEs:

IDE Support Status Skills Directory
Trae ✅ Fully Supported .trae/skills/
Cursor ✅ Fully Supported .cursor/skills/
VS Code ✅ Fully Supported .vscode/skills/
OpenCode ✅ Fully Supported ~/.config/opencode/skills/
Lingma ✅ Fully Supported .lingma/skills/
Windsurf ✅ Fully Supported .windsurf/skills/
Claude Code ✅ Fully Supported ~/.config/claude-code/skills/

Supported Agent Platforms

This skill can run on the following Agent platforms:

Platform Support Status Description
OpenClaw ✅ Fully Supported Recommended platform - Open-source self-hosted Agent platform with perfect progressive disclosure support
Claude Code ✅ Fully Supported Anthropic's official CLI tool
Other Agent Frameworks ✅ Compatible Any framework supporting SKILL.md specification

Technical Features

  • SKILL.md v3.0 Specification: Fully compliant with the latest standard
  • Progressive Disclosure: Metadata → Instructions → References, reducing token consumption
  • Cross-platform Support: Windows (PowerShell) + Linux/macOS (Bash)
  • Automatic IDE Detection: Environment variables, process detection, config file detection
  • Intelligent Work Classification: Automatic classification based on keywords
  • Git Integration: Deep integration with Git for change tracking
  • Multi-dimensional Statistics: Work type, IDE, developer, trend analysis
  • Standardized Output: Unified log file structure for easy tracing and management

Core Functions

Function Description Output
Auto-create Log Detect development activities and record .devlog/dev-logs/yyyy-MM-dd.md
Smart IDE Detection Environment variable/process/config file detection IDE identifier
Work Classification Automatic classification based on keywords Work type code
Version Tracking Multi-source version number detection Version changes
Statistical Analysis Multi-dimensional data statistics Analysis report

Work Type Classification

Type Code Type Name Trigger Keywords
FEAT Feature Development implement, add, create, new
FIX Bug Fix fix, bug, error, issue
DOCS Documentation document, readme, docs
REFACTOR Refactoring refactor, optimize, improve
TEST Testing test, unit test, e2e
CHORE Configuration config, environment, dependency
REQ Requirement Change requirement, change, adjust

Installation

Installation Instructions

When a user requests to install this skill (e.g., install https://github.com/normdist-ai/devlog), please follow these steps:

  1. Clone the repository (must use git clone, do not download ZIP):

    git clone https://github.com/normdist-ai/devlog.git
  2. Detect current IDE: Determine based on configuration folders in the project directory (e.g., .trae/, .cursor/, .vscode/, etc.)

  3. Copy to corresponding skills directory: Copy the cloned devlog folder to the IDE's skills directory, ensuring the final path is {skills_dir}/devlog/

IDE Skills Directories

IDE Skills Directory Detection Flag
Trae .trae/skills/devlog .trae/ folder exists
Cursor .cursor/skills/devlog .cursor/ folder exists
VS Code .vscode/skills/devlog .vscode/ folder exists
OpenCode ~/.config/opencode/skills/devlog Linux/macOS default path
Lingma .lingma/skills/devlog .lingma/ folder exists
Windsurf .windsurf/skills/devlog .windsurf/ folder exists
Claude Code ~/.config/claude-code/skills/devlog Claude Code CLI environment

Installation Example

# Clone repository
git clone https://github.com/normdist-ai/devlog.git

# Copy to Trae IDE (example)
cp -r devlog .trae/skills/

# Or copy to Cursor IDE
cp -r devlog .cursor/skills/

# Windows PowerShell example
Copy-Item -Recurse devlog .trae\skills/

Installation Verification

After installation, the skills directory structure should be:

{skills_dir}/devlog/
├── SKILL.md           # Skill definition file (required)
├── README.md          # This file
├── README.zh.md       # Chinese documentation
├── LICENSE            # MIT License
├── assets/            # Asset files
├── references/        # Reference documentation
└── templates/         # Template files

Usage

Trigger Phrases

The skill will automatically activate when you mention the following keywords:

  • work log, dev-log, record development
  • update log, today's work

Example Interactions

Record work log:

User: Record today's work

Agent: I'll help you create a work log for today.
       
       📋 Collecting Information
       Let me gather the necessary information...
       
       [Execute collection activities]
       
       ✓ Information collected, detecting IDE...

Generate statistics report:

User: Generate this week's work statistics

Agent: [Analyze log data, generate weekly report]

Query historical records:

User: View yesterday's bug fix records

Agent: [Search log index, return relevant records]

Command Line Tool

# Interactive generation
python scripts/generate_dev_log.py

# Automatic mode
python scripts/generate_dev_log.py --auto

# Statistical analysis
python scripts/generate_dev_log.py --analyze --days 7

Project Structure

devlog/
├── SKILL.md                   # Skill definition (agent instructions)
├── README.md                  # This file (English)
├── README.zh.md               # Chinese documentation
├── LICENSE                    # MIT License
├── assets/                    # Asset files
│   ├── agentskills-checklist.md
│   └── skill-usage-checklist.md
├── references/                # Reference documentation
│   ├── ide-detection.md       # IDE detection details
│   ├── work-classification.md # Work classification guide
│   ├── version-management.md  # Version management guide
│   ├── git-integration.md     # Git integration guide
│   ├── statistics-analysis.md # Statistical analysis guide
│   ├── best-practices.md      # Best practices
│   ├── faq.md                 # FAQ
│   └── glossary.md            # Glossary
└── templates/                 # Template files
    ├── daily-log-template.md      # Daily log template
    ├── weekly-report-template.md  # Weekly report template
    ├── monthly-summary-template.md # Monthly summary template
    └── log-list-template.md       # Log index template

Output Directory Structure

Project Root
└── .devlog/                      # Output directory
    ├── README.md                 # Directory description file
    ├── log-list.md               # Log index list
    ├── dev-logs/                 # Log folder
    │   ├── 2026-04-12.md         # Daily log
    │   └── ...
    ├── reports/                  # Report folder
    │   ├── weekly/               # Weekly reports
    │   └── monthly/              # Monthly reports
    └── charts/                   # Chart files

Working Directory Management

SIPOC Analysis

Supplier Input Process Output Customer
dev-log skill User requirements, Git data Log recording methodology (with templates) Log files in .devlog/ folder User

Notes:

  • Process specifications (template files): Located in the templates/ folder
  • Output files (log files): Located in the .devlog/ folder

File Naming Convention

File Type Naming Format Example
Daily Log yyyy-MM-dd.md 2026-04-12.md
Weekly Report weekly-yyyy-Www.md weekly-2026-W15.md
Monthly Summary monthly-yyyy-MM.md monthly-2026-04.md

Log Index Format

log-list.md records all logs in table format:

Date Day of Week Work Records Total Duration IDE Version Change File Path
2026-04-12 Saturday 3 records 4.5h Lingma 3.2.0→3.2.1 View

Usage Process

  1. Initialize output directory: If .devlog/ directory doesn't exist, create directory and generate README.md
  2. Get current time: Get actual date using Get-Date -Format "yyyy-MM-dd"
  3. Create log file: Create log file in dev-logs/ folder
  4. Update index: Add or update log records in log-list.md

Important Notes:

  • Must use actual current time, not estimated time
  • Must initialize .devlog/ directory and create README.md on first use

README.md Content Specification

.devlog/README.md is the description file for the output directory, automatically generated when initializing .devlog/ directory, containing the following:

# .devlog/ Directory Description

This directory is the runtime output folder for the **dev-log skill**, automatically created and maintained by the agent when using the dev-log skill.

## Directory Properties

- **Type**: Output directory (not version-controlled)
- **Creator**: dev-log skill (Development work log management skill based on AgentSkills specification)
- **Purpose**: Store development work logs, statistical reports, and other files

## Directory Structure

.devlog/
├── README.md                # This description file
├── log-list.md              # Log index list
├── dev-logs/                # Log folder
│   └── yyyy-MM-dd.md        # Daily log
├── reports/                 # Report folder
│   ├── weekly/              # Weekly reports
│   └── monthly/             # Monthly reports
└── charts/                  # Chart files

## Notes

1. Files in this directory are automatically generated by the dev-log skill during runtime. Please do not manually modify index files.
2. This directory should be added to `.gitignore` and not included in version control.
3. Process specifications (template files) are located in the `templates/` folder at the skill root directory, not in this output directory.

Use Cases

Scenario 1: Personal Development Efficiency Tracking

Record: Record immediately after completing each task to track personal work efficiency Statistics: Generate weekly personal work statistics to analyze work type distribution Improve: Optimize work methods based on statistical data

Scenario 2: Team Collaboration Traceability

Transparency: Team members' work is traceable for easier collaboration Knowledge Preservation: Important work is recorded to reduce knowledge loss risk Problem Localization: Quickly find related work records to assist with problem localization

Scenario 3: Project History Records

Version Tracking: Record version changes for easy backtracking Evolution Records: Complete record of project evolution Onboarding Assistance: New members can quickly understand project history

Important Notes

  1. Data Integrity: Ensure log records contain all required fields
  2. Time Accuracy: Use actual time instead of estimated time
  3. Index Synchronization: Must update index after each log creation
  4. Privacy Protection: Do not record sensitive information in logs
  5. Version Control: .devlog/ directory should be added to .gitignore

Documentation Navigation

Getting Started

  1. Skill Main Document - Complete functional description
  2. FAQ - Frequently asked questions

Deep Learning

Template Usage

Core Value

For Individual Developers

  • 📈 Track personal work efficiency
  • 🎯 Quantify work achievements
  • 📚 Accumulate development experience

For Teams

  • 👥 Transparent collaboration process
  • 🔄 Traceable development history
  • 📊 Objective efficiency evaluation

For Projects

  • 🛡️ Reduce knowledge loss risk
  • 🔍 Quick problem localization
  • 📖 Complete project evolution record

Best Practices

Recommended Practices

  1. Record Timely: Record immediately after each important work
  2. Detailed Description: Work content should be specific for easy tracing
  3. Accurate Timing: Record actual start and end times
  4. Complete File List: List all modified files
  5. Standardized Versioning: Strictly follow semantic versioning

Practices to Avoid

  1. Don't Batch Record: Avoid recording a week's work at once
  2. Don't Use Vague Descriptions: Avoid "made some modifications"
  3. Don't Omit IDE: IDE information is critical
  4. Don't Ignore Small Changes: Even small modifications should be recorded

Version History

Version Date Major Updates
2.0.0 2026-04-12 Optimize README, add quick reference guide, working directory management, use cases, important notes, version history, project badges
1.9.0 2026-04-12 Create bilingual README (Chinese and English), reference PDCA project structure
1.8.0 2026-04-12 Optimize ide-detection.md, add AI IDE detection methods like TREA, OPENCODE, etc.
1.7.0 2026-04-11 Improve project documentation structure and reference documents
1.6.0 2026-04-11 Add work classification, version management, Git integration guide documents
1.5.0 2026-04-11 Create log template files (daily, weekly, monthly)
1.4.0 2026-04-10 Improve SKILL.md, add detailed agent instructions
1.3.0 2026-04-10 Add statistical analysis, best practices, FAQ and other reference documents
1.2.0 2026-04-09 Create initial project structure and basic templates
1.1.0 2026-04-09 Add IDE detection methods and work classification logic
1.0.0 2026-04-09 Initial version, based on AgentSkills specification

References

License

This project is licensed under the MIT License - see the LICENSE file for details.

Author

About

Developer work log system with AgentSkills integration

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages