4 ms·
My team uses ReadMe for non-technical documentation. We tried wikis and Google Drive before that and they all felt so... unoptimized. Searching was difficult,
by jtfairbank 10y ago
My team uses ReadMe for non-technical documentation. We tried wikis and Google Drive before that and they all felt so... unoptimized. Searching was difficult, organizing was time consuming, and worst of all the documentation kept getting stale.
While ReadMe is built for hosting code/API documentation, we've had no problems using it for just about everything else. And since the UI is great everyone from my operations lead to my executive assistant are able to jump in right away and contribute towards living documentation.
Down the road, I plan to host our first customer support documentation on ReadMe. The both techies and non-techies can contribute towards keeping it up to date and a lot of the features that devs want with API documentation translate naturally to product support docs, such as the QA / Knowledge Base section.