Skip to content
Skills Library
Programming · Writing

project-documentation

/project-documentation

Project-aware documentation conventions that complement the upstream documentation-writer skill. Use when writing or updating README content, docs pages, user guides, tutorials, or technical blog posts in a repository that provides project context files such as GOALS.md, SCOPE.md, CONVENTIONS.md, or .github/copilot-instructions.md.

Licence
MIT
Last repository change
13.07.2026

Assessment and security

90/ 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.
Content25 / 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
7
Scripts
0
HTML comments
0
URLs in SKILL.md
0
Deprecation

No signals detected. Repository changed on 13.07.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

Project-aware documentation conventions that complement the upstream documentation-writer skill. Use when writing or updating README content, docs pages, user guides, tutorials, or technical blog posts in a repository that provides project context files such as GOALS.md, SCOPE.md, CONVENTIONS.md, or .github/copilot-instructions.md.

Original author description

Project-aware documentation conventions that complement the upstream documentation-writer skill. Use when writing or updating README content, docs pages, user guides, tutorials, or technical blog posts in a repository that provides project context files such as GOALS.md, SCOPE.md, CONVENTIONS.md, or .github/copilot-instructions.md.

How it works

  1. When to use this skill
  2. Layering
  3. Workflow
  4. Scope boundaries
  5. Writing rules
  6. References
Original SKILL.md headings · 55 lines, 330 words
SKILL.md preview
---
name: project-documentation
description: Project-aware documentation conventions that complement the upstream documentation-writer skill. Use when writing or updating README content, docs pages, user guides, tutorials, or technical blog posts in a repository that provides project context files such as GOALS.md, SCOPE.md, CONVENTIONS.md, or .github/copilot-instructions.md.
---

# Project Documentation Companion

This skill complements the upstream `documentation-writer` skill.
Use it to add project-aware documentation judgement on top of Diátaxis guidance.

## When to use this skill

Use this skill when you need to:
- Write or update project documentation that should reflect the repository's goals, scope, and conventions.
- Decide whether content belongs in `README.md`, `docs/`, or another project-owned Markdown file.
- Keep documentation concise, grounded in the codebase, and consistent with local terminology.

## Layering

Treat the writing stack as three layers:

1. `documentation-writer` - Diátaxis framework, audience clarification, and document structure.
2. This skill - project-aware placement, terminology, and review rules.
3. The active repository context files - the source of truth for goals, scope, conventions, and local standards.

## Workflow

1. Start by applying the `documentation-writer` skill for document type, audience, goal, and scope.
2. Read any available context files before drafting:
   - `GOALS.md`
   - `SCOPE.md`
   - `CONVENTIONS.md`
   - `.github/copilot-instructions.md`
3. Ground all terminology and recommendations in those files. Do not invent missing context.
4. Choose the document location using [references/document-placement.md](references/document-placement.md).
5. If a template or starter structure would help, use the relevant file in `assets/`.
6. Before finishing, run through [references/review-checklist.md](references/review-checklist.md).

## Scope boundaries

- This skill is for project documentation, not ADR authoring.
- If the user wants to create or update an ADR, use the dedicated `create-architectural-decision-record` skill instead.
- Do not duplicate ADR templates or ADR process rules here.

## Writing rules

- Keep prose concise and specific.
- Prefer task-oriented guidance over feature tours.
- Reflect the repository's actual structure and workflows rather than generic boilerplate.
- When context files and existing docs disagree, flag the mismatch rather than silently picking one.

## References

- [references/document-placement.md](references/document-placement.md) - decide where content should live.
- [references/review-checklist.md](references/review-checklist.md) - final review checks.
- [assets/readme-section-template.md](assets/readme-section-template.md) - starter for short README sections.
- [assets/how-to-template.md](assets/how-to-template.md) - starter for task-focused how-to guides.
- [assets/tutorial-template.md](assets/tutorial-template.md) - starter for learning-oriented tutorials.
- [assets/technical-blog-template.md](assets/technical-blog-template.md) - starter for technical blog posts.
Files in this package (7)
  • SKILL.md 3 KB
  • assets/how-to-template.md 1 KB
  • assets/readme-section-template.md 1 KB
  • assets/technical-blog-template.md 1 KB
  • assets/tutorial-template.md 1 KB
  • references/document-placement.md 1 KB
  • references/review-checklist.md 1 KB

Versions

RepositoryScoreLicence
This page · markheydon/github-workflows90MIT
testdouble/han100MIT

Database snapshot: 13.11.2026 · package version 6a544786e1d0 (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

  • 100documentation
    Guide for writing technical documentation. Use when creating README files, API documentation, guides, or inline code documentation.
  • 95readme
    When the user wants to create or update a README.md file for a project. Also use when the user says 'write readme,' 'create readme,' 'document this project,' 'project documentation,' or asks for he...
  • 100code-documentation
    Writing effective code documentation - API docs, README files, inline comments, and technical guides. Use for documenting codebases, APIs, or writing developer guides.
  • 100technical-writer
    AI DevKit · Review and improve documentation for novice users. Use when users ask to review docs, improve documentation, audit README files, evaluate API docs, review guides, or improve technical writing.
  • 90dev-loop-readme-writer
    Use when the user asks about writing README files, project documentation, README structure, README best practices, or documentation for open source projects. Do NOT use for: changelogs (dev-loop-changelog-generator), or API documentation.
  • 100user-guides
    Generates task-oriented user guides and how-to documentation for a repository. Creates docs/guides/ with step-by-step instructions for common workflows, integrations, and advanced usage. Links guides into README.md and CONTRIBUTING.md. Use when a project needs user-facing how-to…

Feedback and reports

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