DEV Community

#documentation

Improving and writing documentation

Posts

đź‘‹ Sign in for the ability to sort posts by relevant, latest, or top.
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
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
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
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 110
9 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
"Nobody designed the frontmatter"
lisandro_reinoso_d12ac7b9 profile

"Nobody designed the frontmatter"

#metadata #documentation #claude #ai
Comments
3 min read
Confluence databases or a table on a page
mikhailklimenko profile

Confluence databases or a table on a page

#confluence #atlassian #documentation #productivity
Comments
5 min read
Your SOP Is Probably Wrong. Build a Way to Notice.
david_boggs_adaptive profile

Your SOP Is Probably Wrong. Build a Way to Notice.

#productivity #devops #management #documentation
Comments
7 min read
Register the Heading: What AI May Draft in Docs, and What a Human Must Own
datago_7777 profile

Register the Heading: What AI May Draft in Docs, and What a Human Must Own

#documentation #ai #python #devops
Comments
8 min read
Architecture: Write It Down Before Rewriting
fattakhov profile

Architecture: Write It Down Before Rewriting

#architecture #documentation #backend #devops
2
Comments
7 min read
Name a Pin Owner: A One-Page Wiki SOP for Shared Free Agent Runtimes
devx_6522 profile

Name a Pin Owner: A One-Page Wiki SOP for Shared Free Agent Runtimes

#ai #documentation #productivity #devops
Comments
8 min read
đź‘‹ Sign in for the ability to sort posts by relevant, latest, or top.