Have you used GitBook yet, or seen some other awesome documentation? I love hearing other people’s experiences. You can see the results below: Figure: GitBook (red) was the overwhelming winner for End User Documentation Figure: Gitbook (orange) also stood out as the leading tech to build a knowledge base. I asked our team at SSW what they used for different types of documentation, and the overwhelming majority said they choose GitBook for End User documentation as well as creating Knowledge bases. You need to click save or else you can lose information Developer Feedback ❌ $ – The Team version can get expensive (but no more than upkeeping a domain!) ❌ You can’t support different version of the same document, v1, v2 etc. GitBook doesn’t automatically save your edits so, you need to use Save to save your draft and.
USE GITBOOK EDITOR ON GITHUB CODE
❌ There’s no inline highlighting for code blocks (as Jason says in the video) Now, you can add some changes (new draft) on GitBook and merge them to your GitHub repo. ✔️ $ – Can create a PDF, but it’s a paid feature ✔️ You can synchronize your content with GitHub
USE GITBOOK EDITOR ON GITHUB FULL VERSION
✔️ $ – The full version is free for open-source communities ✔️ $ – The base version is free for everyone ✔️ Copying Code – If you have code elements for technical training it allows easy copying and pasting ✔️ Navigation – Has nice navigation on the left ✔️ Integration with Slack, Intercom, GitHub etc. ✔️ Awesome collaboration – you can invite people to your team ✔️ You can have rich content and rich text** ✔️ Content – It’s in Markdown & has a great WYSIWYG editor ❌ Navigation – Does not have any navigation ❌ Nothing is out of the box you have to make everything yourself ✔️ You have complete control over how it looks ❌ Not easy to collaborate – real time sharing is glitchy Plain HTML pages ❌ Copying Code – No code elements for technical training ✔️ Navigation – Has nice navigation on the left It’s easy to get up and running in GitBookjust sync with an existing Git branch or import from Confluence, Notion, GitHub, Dropbox Paper, and Google Docs. Here’s a quick comparison for GitBook compared to a Word document or Plain HTML pages: A Word Document Creating a workbook on GitBook is a great way to help students learn at their own pace and to keep your content current. I think it has revolutionised the way we run our training courses by reducing the amount of preparation time we need before running a course and it gives students something to follow other than a PowerPoint presentation. You can use it for anything from taking personal notes, to creating knowledge bases or product documentation. GitBook is a fun way to write online documentation using nothing more than a web browser. Video: SSW’s Jason Taylor and Adam Cogan talk about building fantastic documentation using GitBook End-User Documentation
0 kommentar(er)
