Forem

# documentation

Improving and writing documentation

Posts

đź‘‹ Sign in for the ability to sort posts by relevant, latest, or top.
I stopped writing runbooks. I built an AI that does it from my actual code instead.
juan_santana_d911a1e322d0 profile

I stopped writing runbooks. I built an AI that does it from my actual code instead.

#showdev #ai #devops #documentation
Comments
2 min read
TechHub: System Documentation
--amadeus-- profile

TechHub: System Documentation

#api #architecture #documentation #nextjs
Comments
3 min read
Why Your API Documentation Is Always Out of Date (and How to Fix It)
nana_tech_66af0dae5019284 profile

Why Your API Documentation Is Always Out of Date (and How to Fix It)

#openapi #documentation #tutorial #devtools
1
Comments
4 min read
Confluence vs Notion for Engineering Teams: An Honest Comparison
Cover image for Confluence vs Notion for Engineering Teams: An Honest Comparison
yamuno101 profile

Confluence vs Notion for Engineering Teams: An Honest Comparison

#documentation #productivity #softwareengineering #tooling
Comments
4 min read
Beyond the README: The Evolution of Markdown in the Age of Generative AI
thejimit profile

Beyond the README: The Evolution of Markdown in the Age of Generative AI

#markdown #ai #webdev #documentation
Comments 1
3 min read
Your API Needs an llms.txt File — Here's How to Write One and Why Agents Will Read It
vystartasv profile
Vilius

Your API Needs an llms.txt File — Here's How to Write One and Why Agents Will Read It

#api #ai #documentation #tutorial
Comments
3 min read
How to Build a Company Knowledge Base That Doesn't Become a Dump
Cover image for How to Build a Company Knowledge Base That Doesn't Become a Dump
trackstack profile

How to Build a Company Knowledge Base That Doesn't Become a Dump

#productivity #documentation #devtools #beginners
Comments
3 min read
Separate Source Documents from AI-Readable Knowledge
Cover image for Separate Source Documents from AI-Readable Knowledge
synthaicode_commander profile

Separate Source Documents from AI-Readable Knowledge

#ai #productivity #architecture #documentation
Comments
5 min read
I Replaced Mintlify With Docs Inside My Dioxus App
hauju profile

I Replaced Mintlify With Docs Inside My Dioxus App

#rust #webdev #documentation
2
Comments
4 min read
From Noise to Signal: Finding README Gaps at Scale
Cover image for From Noise to Signal: Finding README Gaps at Scale
samuelfatzinger profile

From Noise to Signal: Finding README Gaps at Scale

#documentation #opensource #cli #productivity
Comments
3 min read
Git is Your Memory: A Startup Engineer's Guide to Surviving Stakeholders
Cover image for Git is Your Memory: A Startup Engineer's Guide to Surviving Stakeholders
franciscolunadev82 profile

Git is Your Memory: A Startup Engineer's Guide to Surviving Stakeholders

#git #documentation #javascript #architecture
1
Comments 2
3 min read
15 Essential Sections Every README Needs: Give Your Project What It Deserves
Cover image for 15 Essential Sections Every README Needs: Give Your Project What It Deserves

Ready-to-use markdown template
georgekobaidze profile

15 Essential Sections Every README Needs: Give Your Project What It Deserves

#documentation #opensource #tutorial #development
156
Comments 80
11 min read
How I Built a Community Wiki for a Roblox Game (Bridger Western)
lainey_700a31f913db2e8d89 profile

How I Built a Community Wiki for a Roblox Game (Bridger Western)

#showdev #documentation #sideprojects #webdev
Comments
2 min read
I'm with STUPID ⤴️
Cover image for I'm with STUPID ⤴️
gesslar profile

I'm with STUPID ⤴️

#documentation
Comments
5 min read
I Replaced GitBook with a URL Hack — Saving $200/Month
docsbook profile

I Replaced GitBook with a URL Hack — Saving $200/Month

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