Product documentation, processes, and standards, or just personal notes. Having them stored on a cloud drive in separate docs is not user-friendly. There are several web-apps out there that allow you to work on your documentation as a team collaboratively, in a wiki-like manner.
GitBook is one of the tools a client of ours is evaluating to host a GitHub software product documentation. But that is just one use case for the tool. You can create any type of documentation with GitBook.
How it works
The structure of GitBook is pretty simple. First, you create an organization profile, and within that organization, you create a space. A “space” in GitBook can focus on a specific project, or department, or product.
Within a “space”, you can create pages with an easy to use editor. Pages can be organized in a tree-view structure, and easily be linked together.
GitBook is marketed towards software companies that are looking for a tool to host technical documentation. It allows syncing docs with GitHub, and it comes with an option to document APIs (Application Programmable Interfaces). But you can ignore these features and write your own documentation from scratch.
When creating a new page, you can also choose to start with a template. GitBook connects to many known services, like Google Drive and Dropbox, to import existing files you might have.
The page editor comes with all the layout and formatting features you will need to create your documentation: headings, lists, tables, and more.
Other cool features:
- Brand your account (theme settings)
- Make documentation public or private
- Activity feed
- Integrate Slack, Google Analytics, Intercom
- Import Word, Markdown, HTML pages
GitBook is a powerful web app that could be the place for all your company or marketing documentation. Powerful also means you need some time to figure everything out. If you are interested in learning about all the features, access their own documentation, which gives a full view of all the features.
Hand-picked related content:
One Response