Home / hamza-ali-shahjahan / hamzaish · GitHub

documentation-and-adrs SKILL.md skillA

documentation-and-adrs from hamza-ali-shahjahan/hamzaish is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned

mdr add hamza-ali-shahjahan/hamzaish/documentation-and-adrs@git:20260627.bd6e9ea

Pins git:20260627.bd6e9ea in mdr.lock. Pin the fingerprint instead.

Audit grade: A, 17 of 17 checks passed
Kind: SKILL.md skill
Repository: hamza-ali-shahjahan/hamzaish
Path: factory/skills/documentation-and-adrs/SKILL.md
Versions recorded: 1
Latest version: git:20260627.bd6e9ea, committed Jun 27, 2026
Size: 8,734 bytes
Repository stars: 11
License: MIT

Records decisions and documentation. Use when making architectural decisions, changing public APIs, shipping features, or when you need to record context that future engineers and agents will need to understand the codebase.

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

# Documentation and ADRs

## Overview

Document decisions, not just code. The most valuable documentation captures the *why* — the context, constraints, and trade-offs that led to a decision. Code shows *what* was built; documentation explains *why it was built this way* and *what alternatives were considered*. This context is essential for future humans and agents working in the codebase.

## When to Use

- Making a significant architectural decision
- Choosing between competing approaches
- Adding or changing a public API
- Shipping a feature that changes user-facing behavior
- Onboarding new team members (or agents) to the project
- When you find yourself explaining the same thing repeatedly

**When NOT to use:** Don't document obvious code. Don't add comments that restate what the code already says. Don't write docs for throwaway prototypes.

## Architecture Decision Records (ADRs)

ADRs capture the reasoning behind significant technical decisions. They're the highest-value documentation you can write.

### When to Write an ADR

- Choosing a framework, library, or major dependency
- Designing a data model or database schema
- Selecting an authentication strategy
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint

mdr add hamza-ali-shahjahan/hamzaish/documentation-and-adrs@sha256:7fed35f9c5b95d8e

The line at the top of this page pins the label git:20260627.bd6e9ea, 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](https://markdownregistry.com/badge/art_7fld27ns3vogl2sf.svg)](https://markdownregistry.com/a/art_7fld27ns3vogl2sf)

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

Versions

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

version	committed	commit	size	audit
git:20260627.bd6e9ea latest	2026-06-27	bd6e9ea	8,734 B	A	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 (8734 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

hamza-ali-shahjahan/hamzaish · 11 stars · license MIT · pushed 2026-10-07 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_7fld27ns3vogl2sf
GET https://markdownregistry.com/api/v1/resolve?ref=hamza-ali-shahjahan/hamzaish/documentation-and-adrs
GET https://markdownregistry.com/api/v1/blob/7fed35f9c5b95d8e3623ad24d78d209c3267ab62d7157fc03954c76a7e58adf4

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 hamza-ali-shahjahan/hamzaish

hamzaish Cursor rule

hamza-ali-shahjahan/hamzaish · .cursor/rules/hamzaish.mdc · Hamzaish factory — universal operating context for any agent working in this repo

git:20260614.1c0c7ab · audit A · 11 stars

AGENTS.md AGENTS.md file

hamza-ali-shahjahan/hamzaish · AGENTS.md

git:20260921.82b1475 · audit A · 11 stars

CLAUDE.md CLAUDE.md file

hamza-ali-shahjahan/hamzaish · CLAUDE.md

git:20261007.6b62766 · audit A · 11 stars

CLAUDE.md@_archive/v0 CLAUDE.md file

hamza-ali-shahjahan/hamzaish · _archive/v0/CLAUDE.md