DEV Community

# documentation

Improving and writing documentation

Posts

👋 Sign in for the ability to sort posts by relevant, latest, or top.
The Problem Nobody's Measuring
writerviber profile
Ed G

The Problem Nobody's Measuring

#ai #api #devrel #documentation
1
Comments
3 min read
Database documentation fails when it relies on human discipline
thiago_rosadasilva_0688 profile

Database documentation fails when it relies on human discipline

#database #sql #architecture #documentation
Comments
1 min read
Database documentation fails when it relies on human discipline
thiago_rosadasilva_0688 profile

Database documentation fails when it relies on human discipline

#database #sql #architecture #documentation
Comments
1 min read
Your README Is Your Book Cover. Here's the Checklist I Use for 50+ Projects
osovsky profile

Your README Is Your Book Cover. Here's the Checklist I Use for 50+ Projects

#github #opensource #documentation #productivity
2
Comments
4 min read
How to record a narrated video walkthrough of your API docs
custodiaadmin profile

How to record a narrated video walkthrough of your API docs

#video #api #documentation #devtools
Comments
2 min read
Static Docs are Dead: How I Built a Global Documentation Engine with Gemini AI and Lingo.dev
bhupendra_lute profile

Static Docs are Dead: How I Built a Global Documentation Engine with Gemini AI and Lingo.dev

#lingodotdev #cicd #documentation
Comments
3 min read
MD Files Connector — Stop Losing Track of Your Markdown Docs
maneesh_thakur_d16c2852fa profile

MD Files Connector — Stop Losing Track of Your Markdown Docs

#github #devops #python #documentation
1
Comments
1 min read
MEO - a Markdown editor for VS Code with live/source toggle
vadimmelnicuk profile

MEO - a Markdown editor for VS Code with live/source toggle

#productivity #opensource #markdown #documentation
Comments
1 min read
Diagrams: Making the Invisible Visible in Technical Documentation
geanruca profile

Diagrams: Making the Invisible Visible in Technical Documentation

#documentation #diagrams
Comments
2 min read
Why Documentation Fails in Engineering Teams
arto-b profile

Why Documentation Fails in Engineering Teams

#documentation #engineering #architecture #devops
3
Comments 2
4 min read
WorkSafeBC-oriented workflows without overclaims: structured summaries, careful language
crisiscoresystems profile

WorkSafeBC-oriented workflows without overclaims: structured summaries, careful language

#documentation #softwaredevelopment #softwareengineering #tutorial
Comments
3 min read
Why Your Documentation Is Always Stale (And How to Fix It With Git Hooks)
suhteevah profile

Why Your Documentation Is Always Stale (And How to Fix It With Git Hooks)

#documentation #devtools #opensource #productivity
Comments
2 min read
API Documentation: Good, Bad, and Unusable
apiverve profile

API Documentation: Good, Bad, and Unusable

#documentation #devrel #apievaluation #bestpractices
Comments
6 min read
Writing for humans is no longer enough. Writing for AI is now part of the job
siddhartha_mani_03 profile

Writing for humans is no longer enough. Writing for AI is now part of the job

#ai #documentation #testing #llm
Comments
3 min read
I Built an Open-Source AI Tool That Turns Any Codebase Into Deep Engineering Documentation (Runs 100% Locally)
abdulkareemtpm profile

I Built an Open-Source AI Tool That Turns Any Codebase Into Deep Engineering Documentation (Runs 100% Locally)

#opensource #ollama #nextjs #documentation
1
Comments
2 min read
👋 Sign in for the ability to sort posts by relevant, latest, or top.