documentation-writing SKILL.md skillA

documentation-writing from dayfinggg/openai-codex-agent-skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add dayfinggg/openai-codex-agent-skills/documentation-writing@git:20261101.ec2d422

Pins git:20261101.ec2d422 in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
dayfinggg/openai-codex-agent-skills
Path
codex/skills/documentation-writing/SKILL.md
Versions recorded
1
Latest version
git:20261101.ec2d422, committed Nov 1, 2026
Size
3,864 bytes
Repository stars
8
License
MIT

Write and maintain project documentation. Use when creating or updating README files, guides, API references, runbooks, architecture decision records, or changelogs, including documentation needed for the current implementation task. Do not use solely to research external documentation or answer an ordinary chat question.

Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.

What the file says

Document verified behavior for a specific reader and task. Preserve the user's requirements, the project's language, and its established format. This skill does not authorize additional documents, code changes, publication, or Git operations beyond the requested work.

1. Find the repository rules, existing documentation, and the source of the behavior being described. Compare the implementation, public interface, configuration, dependency versions, and executed checks. Distinguish implemented behavior, proposals, and unknown conditions. Do not document an assumption as an established contract.

2. Choose the form that serves the reader's need. A tutorial supports learning, a how-to guide solves a specific task, a reference describes an interface precisely, and an explanation develops understanding of the design and its reasons. Do not reorganize existing documentation solely to impose this classification. This distinction follows [Diátaxis](https://diataxis.fr/).
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add dayfinggg/openai-codex-agent-skills/documentation-writing@sha256:c3c414ce8a91975c

The line at the top of this page pins the label git:20261101.ec2d422, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_xx6wgis4v4imjmo2.svg)](https://markdownregistry.com/a/art_xx6wgis4v4imjmo2)

1 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 1 version of this file, committed on Nov 1, 2026.

versioncommittedcommitsizeaudit
git:20261101.ec2d422 latest2026-11-01 ec2d422 3,864 BA view

Audit of the latest version

A  17 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
  • pass: Frontmatter block present
  • pass: Frontmatter declares a name
  • pass: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (3864 bytes)
  • pass: No zero-width or bidi control characters
  • pass: No instruction hidden inside an HTML comment
  • pass: No link to an exfiltration or paste host
  • pass: No credential-shaped string
  • pass: No instruction to send local credentials anywhere
  • pass: No text hidden with inline styles
  • pass: No prompt-injection phrasing
  • pass: No curl or wget piped into a shell
  • pass: No recursive delete of root, home or parent
  • pass: No instruction to read or print local credentials
  • pass: No base64 blob over 200 characters
  • pass: No link to a raw IP address
  • pass: No script tag

Source

GitHub

dayfinggg/openai-codex-agent-skills · 8 stars · license MIT · pushed 2026-11-01 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_xx6wgis4v4imjmo2
GET https://markdownregistry.com/api/v1/resolve?ref=dayfinggg/openai-codex-agent-skills/documentation-writing
GET https://markdownregistry.com/api/v1/blob/c3c414ce8a91975ca110aeaaac31529dabd05cdd66228251709fdfcd6a39d518

Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.

More from dayfinggg/openai-codex-agent-skills

api-contract-change SKILL.md skill
dayfinggg/openai-codex-agent-skills · codex/skills/api-contract-change/SKILL.md · Implement or modify HTTP API contracts with validation, errors, authorization, and client-compatibility checks. Use for…
git:20261029.276ae81 · audit A · 8 stars
application-cache-change SKILL.md skill
dayfinggg/openai-codex-agent-skills · codex/skills/application-cache-change/SKILL.md · Change application or Redis caching with key, invalidation, concurrency, failure, and data-isolation verification. Use…
git:20261029.276ae81 · audit A · 8 stars
backend-security-change SKILL.md skill
dayfinggg/openai-codex-agent-skills · codex/skills/backend-security-change/SKILL.md · Secure changed backend boundaries while preserving access policy and accepted events. Use for authentication…
git:20261029.276ae81 · audit A · 8 stars
background-job-change SKILL.md skill
dayfinggg/openai-codex-agent-skills · codex/skills/background-job-change/SKILL.md · Change queue consumers, scheduled tasks, or background workers with duplicate-delivery, retry, timeout, shutdown, and…
git:20261029.276ae81 · audit A · 8 stars
ci-failure-diagnosis SKILL.md skill
dayfinggg/openai-codex-agent-skills · codex/skills/ci-failure-diagnosis/SKILL.md · Diagnose failed CI jobs from the exact commit, primary error, environment, and reproduction. Use for failed pipelines…
git:20261029.276ae81 · audit A · 8 stars
code-review SKILL.md skill
dayfinggg/openai-codex-agent-skills · codex/skills/code-review/SKILL.md · Review code changes, branches, or PRs against requirements and repository standards. Select general review or…
git:20261029.276ae81 · audit A · 8 stars
codebase-design SKILL.md skill
dayfinggg/openai-codex-agent-skills · codex/skills/codebase-design/SKILL.md · Design or improve a module interface, dependency seam, or test boundary for the requested change without speculative…
git:20261029.276ae81 · audit A · 8 stars
database-migration-rollout SKILL.md skill
dayfinggg/openai-codex-agent-skills · codex/skills/database-migration-rollout/SKILL.md · Plan and validate schema migrations with lock, data, application-compatibility, rollout, and restoration checks. Use…
git:20261029.276ae81 · audit A · 8 stars
database-query-diagnosis SKILL.md skill
dayfinggg/openai-codex-agent-skills · codex/skills/database-query-diagnosis/SKILL.md · Diagnose slow SQL, lock waits, or connection exhaustion using actual queries, plans, and workload evidence. Use for…
git:20261029.276ae81 · audit A · 8 stars
deployment-verification SKILL.md skill
dayfinggg/openai-codex-agent-skills · codex/skills/deployment-verification/SKILL.md · Prepare or verify an application release with artifact identity, configuration, migrations, readiness, and restoration…
git:20261029.276ae81 · audit A · 8 stars
diagnosing-bugs SKILL.md skill
dayfinggg/openai-codex-agent-skills · codex/skills/diagnosing-bugs/SKILL.md · Diagnose a difficult reproducible bug or performance regression through a feedback loop, competing hypotheses, and…
git:20261029.276ae81 · audit A · 8 stars
docker SKILL.md skill
dayfinggg/openai-codex-agent-skills · codex/skills/docker/SKILL.md · Containerize an application, write or optimize Dockerfiles and image builds, or configure and diagnose Docker Compose…
git:20261029.276ae81 · audit A · 8 stars

Every file in dayfinggg/openai-codex-agent-skills

Other files named documentation-writing

documentation-writing SKILL.md skill
rysweet/amplihack-rs · docs/claude/skills/documentation-writing/SKILL.md · Writing clear, discoverable software documentation following the Eight Rules and Diataxis framework. Use when creating…
v1.0.0 · audit A · 13 stars
documentation-writing SKILL.md skill
rysweet/amplihack-rs · amplifier-bundle/skills/documentation-writing/SKILL.md · Writing clear, discoverable software documentation following the Eight Rules and Diataxis framework. Use when creating…
v1.0.0 · audit A · 13 stars
documentation-writing SKILL.md skill
higoralves/orc · orc/skills/documentation-writing/SKILL.md · Diátaxis documentation expert
git:20261020.7a1f356 · audit A · 7 stars

Browse by kind, by grade A, or by owner.