DEV Community

#documentation

Improving and writing documentation

Posts

đź‘‹ Sign in for the ability to sort posts by relevant, latest, or top.
Catch Broken Markdown Links and #Anchors Offline Before They Hit Production with DeadLinkFinder
umutgungor profile

Catch Broken Markdown Links and #Anchors Offline Before They Hit Production with DeadLinkFinder

#python #cli #opensource #documentation
1
Comments
3 min read
Why File Organization Should Be Semantic, Not Filename-Based
uglypeardata profile

Why File Organization Should Be Semantic, Not Filename-Based

#filemanage #semantic #documentation #ai
Comments
5 min read
The Three-Layer System for Consistent AI Specifications
royberris profile

The Three-Layer System for Consistent AI Specifications

#ai #architecture #softwareengineering #documentation
Comments
10 min read
Your README Is Lying to You: Test Your Onboarding Docs Like You Test Code
eme_gug_0821b41b948be6516 profile

Your README Is Lying to You: Test Your Onboarding Docs Like You Test Code

#documentation #devops #opensource #productivity
Comments
7 min read
Freeze a Reader Contract Before Models Draft Tutorial Pages
github_7727 profile

Freeze a Reader Contract Before Models Draft Tutorial Pages

#documentation #tutorial #testing #ai
Comments
9 min read
Block Unregistered Facts Before a Model Drafts a Concept Page
github_7727 profile

Block Unregistered Facts Before a Model Drafts a Concept Page

#documentation #python #testing #ai
1
Comments
10 min read
Merge Documentation by Heading So Models Cannot Replace Owned Sections
github_7727 profile

Merge Documentation by Heading So Models Cannot Replace Owned Sections

#documentation #python #testing #tutorial
Comments
10 min read
Draft the Migration Note. Refuse the Unsigned Number.
datago_7777 profile

Draft the Migration Note. Refuse the Unsigned Number.

#documentation #ai #testing #devops
Comments
7 min read
From Markdown to Explainer Video: A Developer's Workflow for Documentation People Actually Watch
pierre_9cc21c575d5e066c8f profile

From Markdown to Explainer Video: A Developer's Workflow for Documentation People Actually Watch

#documentation #productivity #tools
1
Comments
4 min read
Terminology drift is the quiet tax on a large content corpus
akmalurunboev profile

Terminology drift is the quiet tax on a large content corpus

#i18n #localization #writing #documentation
Comments
3 min read
Modeling Waterfront Assets with Shapezo: A Typed Content Pipeline for Docks, Piers, and Wharves
geogenius profile

Modeling Waterfront Assets with Shapezo: A Typed Content Pipeline for Docks, Piers, and Wharves

#architecture #documentation #softwareengineering
Comments
2 min read
Keep Escalation Facts Out of Model-Drafted Troubleshooting Pages
github_7727 profile

Keep Escalation Facts Out of Model-Drafted Troubleshooting Pages

#documentation #tutorial #testing #devops
Comments
9 min read
Why Most User Documentation Fails (And How to Fix Yours)
lukedwighteditor profile

Why Most User Documentation Fails (And How to Fix Yours)

#documentation #webdev #beginners
1
Comments
4 min read
A README skill that deletes claims it cannot source
chromoany profile

A README skill that deletes claims it cannot source

#opensource #github #ai #documentation
1
Comments 3
3 min read
How to Generate API Documentation from an OpenAPI Spec (2026 Guide)
octri profile
Octri

How to Generate API Documentation from an OpenAPI Spec (2026 Guide)

#openapi #api #documentation #tutorial
Comments
5 min read
đź‘‹ Sign in for the ability to sort posts by relevant, latest, or top.