Thoughts on documentation
in: Diary of a solo dev building a web app
I think having documentation is important.
They provide value to users of your software and help in SEO (more content is typically better).
Writing more docs must be easy or else they won’t get written.
The way I do documentation for Filerion is:
But there are many other options e.g. just making Notion page publicly visible or writing in craft.do and using their publishing options.
That being said: more docs is not strictly better.
It’s not about writing more words.
You want minimum amount of words to convey useful information.
What is especially helpful is contextual information.
For example in Filerion I have a panel for configuring S3 access. The user needs to provide account information and it’s not obvious to everyone where to get it.
That is a perfect place to put a link to a page in your docs that explains where to find this information.
Written on Jun 16 2022.
Found a mistake, have a comment? Let me know.

Feedback about page:

Optional: your email if you want me to get back to you: