Skip to content
Skills Library
Programming · Writing

project-docs

/project-docs

This skill should be used when creating or updating this project's documentation — the changelog, issue logs, README, client guide, or flow/workflow docs — typically after implementing or changing code.

Repository
POBG ↗
Licence
MIT
Last repository change
13.11.2026

Assessment and security

100/ 100Class: good
Format25 / 25
Frontmatter with name and description, valid name, description up to 1,024 characters, name matching the folder.
Discoverability25 / 25
Description explains when to use the skill, has a reasonable length and uses third person.
Content35 / 35
At least 150 words and at most 500 lines, headings, step lists, examples or code.
Hygiene15 / 15
No placeholders such as TODO, no Windows paths, with a licence.
Riskno signals detected in the scan
Files in this package
1
Scripts
0
HTML comments
0
URLs in SKILL.md
1
Deprecation

No signals detected. Repository changed on 13.11.2026, without references to retired models or APIs.

Licence

MIT, open: use and modify while retaining author attribution.

What it does and when to use it

This skill should be used when creating or updating this project's documentation — the changelog, issue logs, README, client guide, or flow/workflow docs — typically after implementing or changing code.

Original author description

This skill should be used when creating or updating this project's documentation — the changelog, issue logs, README, client guide, or flow/workflow docs — typically after implementing or changing code.

How it works

  1. docs/ layout
  2. Changelog — docs/changelog/CHANGELOG.md
  3. Issue log — docs/issues/ISSUENNN.md
  4. README & clients
  5. Flow & workflow docs
Original SKILL.md headings · 39 lines, 318 words
SKILL.md preview
---
name: project-docs
description: This skill should be used when creating or updating this project's documentation — the changelog, issue logs, README, client guide, or flow/workflow docs — typically after implementing or changing code.
---

# Project Documentation

## docs/ layout

```
docs/
├── flow/
│   └── system_flow.md   # System flow + data flow diagrams (Mermaid) with description
├── clients.md           # How to connect each MCP client (see README & clients below)
├── workflow/
│   └── workflow.md      # Current development workflow and processes
├── changelog/
│   └── CHANGELOG.md     # Keep a Changelog format
├── issues/
│   └── ISSUE_NNN.md     # One file per issue (NNN = sequential number)
└── reports/             # Test / security / code-review reports (see testing-and-reports skill)
```

## Changelog — `docs/changelog/CHANGELOG.md`
- Follow the [Keep a Changelog](https://keepachangelog.com/) format strictly. Categories: Added, Changed, Deprecated, Removed, Fixed, Security.
- Semantic versioning `[MAJOR.MINOR.PATCH]` with date `YYYY-MM-DD`.
- Every code change gets an entry, added immediately after implementation. Maintain the file manually — it does not depend on git.

## Issue log — `docs/issues/ISSUE_NNN.md`
- Create one when a bug or problem is encountered during development.
- Required sections: **Problem** (what happened), **Cause** (root cause analysis), **Solution** (how it was fixed), **Prevention** (how to avoid recurrence).
- Link the issue number in the related changelog entry when applicable.

## README & clients
- `README.md` (project root): the project's **purpose** and **use cases** — what problem it solves, who/when it is for, and how to get started quickly.
- `README.zh-TW.md`: the Traditional Chinese version of the README; update both together.
- `docs/clients.md`: **how to connect** — one section per MCP client (config file, launcher command, requirements), each labelled tested or not tested, and how to check that it works.

## Flow & workflow docs
- `docs/flow/system_flow.md`: both a **system flow diagram** (component interactions and call relationships) and a **data flow diagram** (input → processing → output/storage). Update whenever the system design or data flow changes.
- `docs/workflow/workflow.md`: development process, build steps, deploy steps, environment-specific notes. Update when the workflow changes.
- All diagrams in this project are **Mermaid** — never screenshots or non-editable image files.

Versions

RepositoryScoreLicence
This page · GGaryyy/POBG100MIT
coco-research/coco100MIT
nasrulhazim/claude100MIT
event4u-app/agent-config100MIT
DPatta/project-docs-kit100MIT
DPatta/project-docs-kit100MIT
jezweb/claude-skills100MIT
waynesutton/builder-skills100Apache-2.0
xstongxue/best-skills100Apache-2.0

Database snapshot: 13.11.2026 · package version b3862c9014a2 (SHA-256 digest of the entire package)

Downloads in the last 30 days: 0 · ranking

Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.

Similar skills

  • 96create-readme
    Use when generating or updating a project README.md or CHANGELOG.md.
  • 100documentation-guide
    Guide documentation structure, content requirements, and project documentation best practices. Use when: creating README, documentation, docs folder, project setup, technical docs. Not for: generating docs mechanically from source — use /docgen; changelog entries — use…
  • 100generating-project-docs
    Use when creating, refreshing, or updating project-level documentation — README.md, ARCHITECTURE.md, STRUCTURE.md, or scoped section updates
  • 100readme-docs
    Creates or updates the README.md of a software project (backend, frontend, mobile, library, CLI or anything else) following a documentation standard with mandatory, conditional and optional sections. Use it when the user asks to document a project, create or improve the README,…
  • 100docs
    This skill should be used when the user asks about "documentation", "README", "CHANGELOG", "CONTRIBUTING", "ADR", "architecture decision record", "changelog format", "keep a changelog", "doc comments", "API documentation", or needs guidance on project documentation requirements.
  • 90update-project
    Use when updating docs, syncing AGENTS.md, CLAUDE.md, or README.md, fixing stale documentation, or refreshing project rules and skills. Keeps docs aligned with code changes.

Feedback and reports

Your message goes to Bartosz Sokoliński. An email address is needed only for a reply. See the privacy policy.