Replying to Avatar Enki

So this opinion probably comes from the fact that I've never written extensive documentation before. But if you take the time to write a lot of documentation for an application and spend the time to set up a complex website for it.......would it be that much extra effort to distill it into a much less pain in the ass PDF for people?

I'm trying to read the docs for a new web hosting app I'm using, but the doc website is set up so poorly that's it a pain in the ass to read through. But they obviously put a lot of effort into it. 🤦‍♂️
3c
₿itcoin 1y ago

Plain text is handy.

Reply to this note

Please Login to reply.

Discussion

3c
₿itcoin 1y ago

because you can easily search trough it. A search bar is the most important. Not on the server, but just local. In the browser or text editor.

This would be my top documentation experience:

I have a problem, I visit documentation site, I see everything in plain text and thus I can search in an instant trough all text to find what I need. I might even easily copy all text at once, paste it into vim or another text editor, and use advanced search. I could even use `git grep "search string"` if the documentation is a github repo.