DEV Community

#documentation

Improving and writing documentation

Posts

👋 Sign in for the ability to sort posts by relevant, latest, or top.
I scanned four popular Python libraries for missing docstrings

I scanned four popular Python libraries for missing docstrings

Comments
1 min read
Your Schema Isn't Enough: Build a SQL Agent That Reads Business Knowledge First (OKF Series, Part 4)

Your Schema Isn't Enough: Build a SQL Agent That Reads Business Knowledge First (OKF Series, Part 4)

1
Comments
40 min read
I wrote my last ticket

I wrote my last ticket

Comments
4 min read
When the design doc and the code disagree, which one is wrong?

When the design doc and the code disagree, which one is wrong?

Comments
4 min read
Claim, Argument, and the Discipline of Not Fooling Yourself

Claim, Argument, and the Discipline of Not Fooling Yourself

Comments
4 min read
Recording generated-asset provenance, originals, and selection decisions

Recording generated-asset provenance, originals, and selection decisions

Comments
4 min read
What If Building a Website Didn't Need a Build Step?

What If Building a Website Didn't Need a Build Step?

Comments
8 min read
첫 번째 스프린트 이후에도 프로젝트 참조 링크를 유용하게 유지하는 방법

첫 번째 스프린트 이후에도 프로젝트 참조 링크를 유용하게 유지하는 방법

Comments
1 min read
New Developers Struggle with Modular Code Navigation; Structured Documentation and IDE Tools Offer Solutions

New Developers Struggle with Modular Code Navigation; Structured Documentation and IDE Tools Offer Solutions

Comments
10 min read
Should a broken link fail your CI build? Block internal links, warn on external ones

Should a broken link fail your CI build? Block internal links, warn on external ones

Comments
5 min read
👻 GhostDocs: Bringing Forgotten Knowledge Back to Life

Hacktoberfest Open-Source AI Challenge: Ghost in the Machine Submission 👻🌼

👻 GhostDocs: Bringing Forgotten Knowledge Back to Life

2
Comments
3 min read
How to Document an AI Workflow So You Can Reproduce It 30 Days Later

How to Document an AI Workflow So You Can Reproduce It 30 Days Later

Comments
2 min read
Grok is obsessed with our docs. Just not the parts we built for it.

Grok is obsessed with our docs. Just not the parts we built for it.

1
Comments 1
1 min read
Writing a README People Actually Read: Notes From a Writer Learning to Code

Writing a README People Actually Read: Notes From a Writer Learning to Code

1
Comments
2 min read
Building hldays #10: Docs that sell the API

Building hldays #10: Docs that sell the API

Comments 1
7 min read
👋 Sign in for the ability to sort posts by relevant, latest, or top.