Skip to content

What do you use for documentation that actually gets read?

General Discussion by Bruno22 26 replies 3.2K views
2 #1

We try wiki at my company, but nobody update, is very dead. I make a test with Notion too but same problem, people write one time and forget

I need something low friction, maybe closer to where we already talk? We use Slack but history disappear and search is very bad

What you use that actually works? The tool is not problem, the people is problem I think, but maybe exist a tool that fix the people haha

ping so high I wave back
#2

We moved everything to the repo itself, markdown files next to code. Sent ticket yesterday about something and engineer just updated the same file, worked great!

The trick was making it easier to edit than to ask in chat. If they have to open separate wiki, they won't. Made test order with this approach and saw 3x more contributions in first month.

One thing: you need someone curating or it becomes mess. Cheers!

swimming upstream since 2019 🐟
#3

I use angry forum post hos ạ

Very cheap effort, people read because they want argue back ạ no final consonant needed for good doc ạ

Serious hos I try gitbook before but same problem everyone say ạ

#4

@van3 wkwkwk this is actually can work lah, if the forum is searchable and not slow-slow delete the old post

I try Confluence before, very expensive, and still nobody read also. Now I just write in README with many thank you to the person who update it, make them feel good. Can work better than fancy tool.

But angry forum post... thank you for the idea, maybe I will try in internal Slack channel first, thank you.

wrap it, ship it, pray it
#5

The real answer is nobody reads documentation. They read error messages. They read stack traces. They read forum threads when something breaks. Everything else is vanity. Write better errors instead;

SPF, DKIM, DMARC — holy trinity ✉️
#6
van3 said:
I use angry forum post

Actually, "host" has a final consonant cluster. Dropping it obscures meaning.

I write commit messages that explain why, not what. The code shows what. My team reads them because they must during git blame. Semicolons used correctly separate related independent clauses. Most do not grasp this distinction.

#7

Markdown in repo is the only thing that ever worked for us too

#8

Curating sounds like a full job. Who actually does that without burning out?

SPF, DKIM, DMARC — holy trinity ✉️
#9
mediaaustin said:
Curating sounds like a full job. Who actually does that without burning out?

We rotate it. One week per person, like on-call but for docs. Nobody dies if a page is stale for five days, and the load is light enough that people don't hate it. Key is keeping the rotation visible so shame does the rest.

swimming upstream since 2019 🐟
#10

Shame is a hell of a motivator. I should try that with my SPF records.

SPF, DKIM, DMARC — holy trinity ✉️

Post a reply

You need an account to reply. Log in or register to join the conversation.

Post reply Preview Save draft