News for hackers. Stuff that matters.
Re:The Surprising Power of Documentation by SkipperCat on Monday June 12, 2023 @10:12PM (#36304258)
I should probably elaborate. When saying simple, I meant don't add content that doesn't relate to what the user needs to use the product. There's nothing worse than having to read a several paragraphs of unrelated content just to get to the nugget of info which tells you how to actually use the product.

If the user needs complex docs to perform a complex task - that's 100% OK. Just don't write complex content when a simple (or direct) explanation will do.

There are no comments on this comment yet.