DEV Community

#documentation

Improving and writing documentation

Posts

đź‘‹ Sign in for the ability to sort posts by relevant, latest, or top.
How i documented a Broken codebase without losing my mind.
iacobandrei profile

How i documented a Broken codebase without losing my mind.

#documentation #github #softwareengineering
Comments
5 min read
A Useful VPN Bug Report Starts with the Last Successful Step
m_montazeri profile

A Useful VPN Bug Report Starts with the Last Successful Step

#vpn #networking #documentation
Comments
4 min read
My AI wrote API docs. Then a parser fact-checked it.
babar_khan_bd8e81ea18e344 profile

My AI wrote API docs. Then a parser fact-checked it.

#ai #webdev #opensource #documentation
1
Comments 1
2 min read
How to make a diagram clickable in Confluence Cloud
mikhailklimenko profile

How to make a diagram clickable in Confluence Cloud

#confluence #atlassian #documentation #diagrams
Comments
5 min read
Draft Changelog Inventory From Git; Keep Upgrade Claims in a Reviewer Contract
github_7727 profile

Draft Changelog Inventory From Git; Keep Upgrade Claims in a Reviewer Contract

#documentation #python #git #testing
Comments
8 min read
Learning to Fit the Room: A Skill I Built to Practice Concision
franciscoh017 profile

Learning to Fit the Room: A Skill I Built to Practice Concision

#ai #concision #writing #documentation
2
Comments 1
5 min read
Generate How-To Skeletons From Signatures, Then Gate README Promises With a Lane File
github_7727 profile

Generate How-To Skeletons From Signatures, Then Gate README Promises With a Lane File

#python #documentation #opensource #testing
Comments
7 min read
Clean Code Is Not the Same as Clear Code: Comments Were Never the Problem

Includes a helpful regex breakdown in the comments
georgekobaidze profile

Clean Code Is Not the Same as Clear Code: Comments Were Never the Problem

#discuss #programming #documentation #coding
143
Picked as gem Comments 125
9 min read
Your README Is Lying to New Contributors
readmeforge profile

Your README Is Lying to New Contributors

#programming #opensource #documentation
1
Comments
3 min read
Self-Improving Docs, Part 1: Automatically Turning Documentation Gaps Into Pull Requests
meharshit profile

Self-Improving Docs, Part 1: Automatically Turning Documentation Gaps Into Pull Requests

#devrel #documentation #ai #bestofdev
Comments
9 min read
Lens: screenshots and click-by-click guides, with no account and no server
open-post profile

Lens: screenshots and click-by-click guides, with no account and no server

#chrome #extensions #documentation #javascript
5
Comments
4 min read
Your README's code examples are untested — here's how I test mine in any language
ingridowusu profile

Your README's code examples are untested — here's how I test mine in any language

#testing #documentation #cli #devtools
1
Comments
3 min read
I Turned a Lecture PDF Into a Deck Without Rewriting a Line
kouki profile

I Turned a Lecture PDF Into a Deck Without Rewriting a Line

#productivity #ai #documentation #tutorial
Comments
4 min read
Can a new engineer ship a change in week one? Test your repo before you hire
redliolabs profile

Can a new engineer ship a change in week one? Test your repo before you hire

#onboarding #devops #productivity #documentation
Comments 1
4 min read
How We Built a 12,000-Template SOP Library (And What We Learned About Documentation)
victordisouza39 profile

How We Built a 12,000-Template SOP Library (And What We Learned About Documentation)

#productivity #documentation #startup #webdev
Comments 1
3 min read
đź‘‹ Sign in for the ability to sort posts by relevant, latest, or top.