10
8 Comments

Do you keep your app documentation within your app, or as a public section on your marketing website?

Started to build out a '/docs' section of my marketing website to house documentation and knowledge base information for my app. Have it linked from within the app to open in a new tab. I originally did this for the SEO potential value, and ease of updates. But are there other reasons I am missing as to why I might want to build it into my application and be more accessible for users when they are in the app?

on June 1, 2022
  1. 1

    I think GitBook is great and it has a free option. I use it for my project Hology. https://docs.hology.app/

  2. 1

    I've found the users that want docs, will seek them out and don't mind them not being built-in to the product. I've had a lot of success with Retype, typically doing what you suggested, hosting it under /docs.

    1. 1

      That's helpful, thank you!

  3. 1

    Since it's a web app, what's stopping you from doing both?

    1. 1

      I would say effort to maintain 2 separate sources - marketing site is wordpress, web app is firebase

      1. 1

        While clearly I don't know all of the details involved with your specific implementations, conceptually it would seem that what you would need would effectively be two different 'views' based off of a single, common source, which is a frequently used software design pattern that ought to be readily do-able.

  4. 1

    I'd stick with it on the website for two main reasons.

    1 so that any potential user could see and read them before downloading the app.

    2 so that if needed they can have the docs open on a laptop etc to read what to do while the app is running on tablet / phone.

    1. 1

      In my case, should have specified its a web app, but yes good points!