Notre avis
Crée des entrées de journal horodatées pour documenter découvertes, recherches, réunions, revues de code et autres événements significatifs durant le développement.
Points forts
- Structure standardisée avec métadonnées (type d'événement, sources, tags)
- Nommage automatique des fichiers basé sur la date et un slug descriptif
- Types d'événements prédéfinis couvrant les activités courantes
Limites
- Nécessite un répertoire `docs/log/` préexistant
- Les tags et sources sont limités en nombre (10 tags, 5 sources)
- N'inclut pas de fonctionnalité de recherche ou de visualisation automatique
Lorsque vous devez consigner une découverte, une réunion, une recherche ou tout événement méritant d'être tracé dans un format cohérent et horodaté.
Pour des notes informelles très courtes ou lorsque le projet ne nécessite pas une documentation structurée des événements.
Analyse de sécurité
SûrThe skill only instructs creating structured Markdown log files in a docs/log/ directory. There are no commands for code execution, network access, destructive actions, or handling of secrets. It uses no external tools beyond file writing, which is a standard safe operation for documentation.
Aucun point d'attention détecté
Exemples
Log a research entry about comparing authentication frameworks. Use sources from https://example.com/auth-comparison and https://example.com/jwt-guide. Tags: authentication, security, oauth2.Create a log entry for today's sprint planning meeting. Event type: meeting. Include tags: sprint, planning, team. Save it with a meaningful slug.Log a code review of the pull request #42. Event type: code review. Summary: Reviewed the new API endpoint implementation. Tags: api, code-review.name: log description: Create log entries with timestamps. Use this when documenting discoveries, research findings, meetings, code reviews, articles, videos, or significant events during development.
Log Entry Skill
Instructions
When creating a log entry, follow these steps:
- Determine the event type - Choose from: deep dive, meeting, research, code, code review, article, video
- Write a summary - Create a brief, clear summary of the entry
- Gather sources - List relevant references, links, or sources (up to 5)
- Add tags - Tag the entry for easy discovery and organization (up to 10)
- Create the file - The file will be named with a date and reference slug:
YYYY-MM-DD_reference-slug.md
Log Entry Structure
Log entries follow this format:
---
summary: A brief summary of the log entry
event_type: deep dive | meeting | research | code | code review | article | video
sources:
- source1
- source2
- source3
- source4
- source5
tags:
- tag1
- tag2
- tag3
- tag4
- tag5
- tag6
- tag7
- tag8
- tag9
- tag10
---
[Your detailed entry content here]
Event Types
- deep dive - In-depth exploration or analysis of a topic
- meeting - Notes from meetings or discussions
- research - Research findings or investigations
- code - Code changes, implementations, or technical work
- code review - Review notes and feedback on code changes
- article - Summary of an article or blog post
- video - Notes from a video or presentation
File Naming
Log entries are saved in docs/log/ with date and reference slug:
Format: YYYY-MM-DD_reference-slug.md
Examples:
2025-12-30_authentication-research.md2025-12-30_meeting-notes.md2025-12-30_performance-review.md
The slug should be:
- Lowercase
- Hyphen-separated words
- Descriptive and meaningful (e.g.,
auth-framework,performance-review,bug-investigation)
This format ensures chronological ordering while keeping entries discoverable by their descriptive slug.
Content Guidelines
After the YAML frontmatter, include:
- Clear, concise description of the log entry
- Key findings or decisions
- Next steps if applicable
- Related decisions or references to ADRs
Example
---
summary: Evaluated authentication frameworks for the project
event_type: research
sources:
- https://example.com/auth-comparison
- https://example.com/jwt-guide
- https://example.com/oauth2-tutorial
tags:
- authentication
- security
- framework-evaluation
- oauth2
- jwt
---
# Authentication Framework Research
Researched three main authentication approaches...
## Key Findings
- Option A provides the best developer experience
- Security model aligns with our requirements
- ...
## Next Steps
- Prototype with Option A
- Get team review
Template Reference
The project uses a standardized template located at docs/log/TEMPLATE.md for reference.
Generateur de Documentation API
Documentation
Genere automatiquement de la documentation API OpenAPI/Swagger.
Rédacteur Technique
Documentation
Rédige de la documentation technique claire selon les meilleurs style guides.
Décision de Pivot Stratégique
Documentation
Documente une décision stratégique de pivot ou de persévérance avec preuves, analyse et justification. À utiliser pour évaluer s'il faut changer de cap sur un produit, une fonctionnalité ou une stratégie en fonction des retours du marché.