DEV Community

#documentation

Improving and writing documentation

Posts

👋 Sign in for the ability to sort posts by relevant, latest, or top.
Write a Public Beta Quickstart That Ends With a Checkable Result
urielbitton profile

Write a Public Beta Quickstart That Ends With a Checkable Result

#showdev #webdev #beginners #documentation
1
Comments
6 min read
Auto-Generate Project Documentation with AI: A Python Workflow
the_movie_9b1357e8c99cfaa profile

Auto-Generate Project Documentation with AI: A Python Workflow

#python #documentation #ai #programming
Comments
7 min read
Scope the Doc Before the Prompt: What a Model May Draft and What a Human Must Own
github_7727 profile

Scope the Doc Before the Prompt: What a Model May Draft and What a Human Must Own

#documentation #ai #python #devops
Comments
7 min read
Anchor Coverage: A CI Gate for Docs a Model May Draft but Never Own
datago_7777 profile

Anchor Coverage: A CI Gate for Docs a Model May Draft but Never Own

#documentation #ai #devops #testing
Comments
6 min read
Decide What a Model May Draft Before It Writes: A Section Ownership Gate for Docs
github_7727 profile

Decide What a Model May Draft Before It Writes: A Section Ownership Gate for Docs

#ai #documentation #devops #productivity
Comments
7 min read
Runbook Rot: Three Fingerprints of Stale CI Docs and the Check That Catches Each
yuhehe profile

Runbook Rot: Three Fingerprints of Stale CI Docs and the Check That Catches Each

#automation #ci #devops #documentation
Comments
4 min read
Draft Rights per Doc Section: A TOML Policy and a 90-Line Gate for What a Model May Write
github_7727 profile

Draft Rights per Doc Section: A TOML Policy and a 90-Line Gate for What a Model May Write

#ai #documentation #devops #testing
Comments
7 min read
Software Statement of Work (SOW) Template and Guide
oleksandr_tytarenko profile

Software Statement of Work (SOW) Template and Guide

#softwareengineering #freelance #productmanagement #documentation
Comments 1
7 min read
How to Render Mermaid Diagrams in Markdown
thattoolsite profile

How to Render Mermaid Diagrams in Markdown

#markdown #documentation #webdev #tutorial
Comments
3 min read
Marker-Delimited Doc Regions: A Hash Gate That Keeps Model Drafts Out of Human-Owned Text
github_7727 profile

Marker-Delimited Doc Regions: A Hash Gate That Keeps Model Drafts Out of Human-Owned Text

#documentation #ai #python #devops
Comments
8 min read
Anchor Troubleshooting Docs to Real Error Strings Before a Model Drafts Them
github_7727 profile

Anchor Troubleshooting Docs to Real Error Strings Before a Model Drafts Them

#documentation #python #devtools #ai
Comments
7 min read
Our README tells you to make a Gmail app password, and nothing in the app has read one for months
daniel_pertu profile

Our README tells you to make a Gmail app password, and nothing in the app has read one for months

#documentation #electron #node #webdev
Comments
5 min read
I audited Sentry's agent files. Sixteen days later their own agent refreshed them, so I scored the audit.
astridholmlh profile

I audited Sentry's agent files. Sixteen days later their own agent refreshed them, so I scored the audit.

#ai #claude #documentation #opensource
Comments
3 min read
When a Model-Drafted Doc Section Earns a Human Owner: An Escalation Ladder and a Trailer Gate
github_7727 profile

When a Model-Drafted Doc Section Earns a Human Owner: An Escalation Ladder and a Trailer Gate

#documentation #devops #ai #githubactions
Comments
7 min read
Sign the Sentences, Not the PR: An Approval Ledger for Model-Drafted Doc Blocks
github_7727 profile

Sign the Sentences, Not the PR: An Approval Ledger for Model-Drafted Doc Blocks

#documentation #git #ai #devtools
Comments
6 min read
👋 Sign in for the ability to sort posts by relevant, latest, or top.