Do you produce the best End-User Documentation?
Last updated by Daniel Mackay [SSW] 24 days ago.See historyDeveloper Documentation
Developer documentation is stored close to the code. Examples are GitHub wiki and Azure DevOps wiki.
End-User Documentation
Option 1: Word document
✅ Pros:
- Content - Easy to edit
- Navigation - Has nice navigation on the left
❌ Cons:
- Copying Code - No code elements for technical training
- No Google Analytics
- Not native to the web
Option 2: Plain HTML pages
✅ Pros:
- You have complete control over how it looks
- Can add Google Analytics
❌ Cons:
- Content - Hard to edit using HTML
- Navigation - Does not have any navigation
- Copying Code - No code elements for technical training
- Lacks basic features, like search
Option 3: GitBook
✅ Pros:
- Content - It's in Markdown
- Navigation - Has nice navigation on the left
- Copying Code - If you have code elements for technical training it allows easy copying and pasting
- Simple Branding options
- It's in GitHub - allows people to give suggestions
- Integrated search
- Integrated with Google Analytics
❌ Cons:
- $ 6.70 USD per user per month (expensive)
Option 4: Nextbook
✅ Pros:
- Content - It's in Markdown
- Navigation - Has nice navigation on the left
- Copying Code - If you have code elements for technical training it allows easy copying and pasting
- It's in GitHub - allows people to give suggestions
❌ Cons:
- No Integrated search
- No Integration with Google Analytics
- No Branding options
- Solo maintainer
- Clunky menu system
Option 5: Docusaurus (recommended)
✅ Pros:
- Content - It's in Markdown
- Navigation - Has nice navigation on the left
- Copying Code - If you have code elements for technical training it allows easy copying and pasting
- Branding via CSS
- It's in GitHub - allows people to give suggestions
- Maintained by Meta (Facebook)
- Highly customizable via plugins
- Integrated search (Algolia and more)
- Integration with Google Analytics (plugin)
- Internationalization (i18n) support
- Free
❌ Cons:
- Need to self-host
Love it
0
Agree
0
Disagree
0
No way
0