project-state-snapshot

Generate a versioned Markdown project snapshot from repository artefacts.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/gw-ai-security/ats-cv-scorer --skill project-state-snapshot
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: project-state-snapshot
Source: https://github.com/gw-ai-security/ats-cv-scorer/tree/main/.codex/skills/project-state-snapshot
Command: npx skills add https://github.com/gw-ai-security/ats-cv-scorer --skill project-state-snapshot

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Erzeuge einen copy-paste-tauglichen Projektstatus mit Repository-Belegen und versioniere ihn, um Statusänderungen nachvollziehbar zu dokumentieren.

Core Features & Use Cases

  • Erfasst Zweck, Scope, Architektur, Implementierung, Tests, CI/CD und Risiken aus zentralen Artefakten wie README.md, docs/, .github/, src/, tests/ und frontend/.
  • Generiert einen versionierten Markdown-Snapshot und speichert ihn unter docs/project_state/YYYY-MM-DD/HHmmss_project_snapshot.md.
  • Markiert fehlende Infos mit "Unbekannt im Repo" und sammelt sie in einer To Clarify-Sektion für Nachverfolgung.

Quick Start

Führe den Snapshot basierend auf dem aktuellen Repo aus und speichere ihn unter docs/project_state/YYYY-MM-DD/HHmmss_project_snapshot.md.

Frequently Asked Questions about project-state-snapshot

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a timestamped project snapshot from my repository?

A project snapshot captures purpose, scope, architecture, implementation, tests, and risks by analyzing repository artifacts like README.md, docs/, and src/. It generates a versioned Markdown document to track status changes over time.

How do I document missing project information when generating a repository status report?

When generating a repository status report, any missing project information is marked as 'Unbekannt im Repo'. These missing details are compiled into a dedicated To Clarify section for future follow-up and verification.

Can I use this to track CI/CD pipelines and frontend architecture in my project?

Yes, you can track CI/CD pipelines and frontend architecture because the tool explicitly analyzes the .github/ and frontend/ directories. It extracts implementation details and compiles them into the versioned Markdown snapshot.

What is the best way to version and save project state documentation?

The best way to version project state documentation is using a fixed Markdown template saved with precise timestamps. This tool automatically stores snapshots under docs/project_state/YYYY-MM-DD/HHmmss_project_snapshot.md for chronological tracking.

Does the project snapshot include risk assessment and testing coverage?

Yes, the project snapshot includes risk assessment and testing coverage by scanning the tests/ directory and core artifacts. It documents these aspects within the generated Markdown file to provide a comprehensive project overview.