Managing Product Documentation - Wiki?
-
-
- Kerry Lebel
- Newbie
- Posts: 10
- Thanks: 0
-
Hey All,
I really like how Rockettheme has their product documentation laid out so nicely. www.rockettheme.com/docs Is that just a series of articles or is there a cleaner plug-in I can use for handling and linking through all my product documentation for our software? Any suggestions?
Thanks.
-
-
-
- Kerry Lebel
- Newbie
- Posts: 10
- Thanks: 0
- Bueller? Bueller? No one knows?
-
-
-
- Andy Miller
- Preeminent Rocketeer
- Posts: 9919
- Thanks: 96
- Web Kahuna
-
We wrote a custom component we call RokDocs that uses markdown files hosted on GitHub to render the documentation pages:
github.com/rockettheme/docs
You can browse the documentation right on GitHub, make changes, merge pull requests etc. This means that we can easily get fixes and edits from our community and quickly merge them into the 'master' copy that gets automatically synced with the live RocketTheme site.
This is not a public component at this time because we do some things that are quite specific to our needs, for example with the image overlays. We have considered making this a product though if the demand was there.
Incidentally we also use this same system for the Gantry documentation:
www.gantry-framework.org/documentation
Hope this helps! -
The following users have thanked you: Kerry Lebel
-
-
-
- Kerry Lebel
- Newbie
- Posts: 10
- Thanks: 0
-
Andy this is good stuff. I like where you went with it. Online product documentation as a whole is a massive headache for a lot of SaaS based companies and solutions like Mediawiki just don't cut the mustard. You guys might consider productizing the solution at some point. I would have paid for something clean that made my life easier managing, organize and tag How-To guides, FAQ's, Install guides, etc etc all centrally while allowing users to rate documentation and comment on it. (Not necessarily be able to edit)
Kerry
Andy Miller wrote:We wrote a custom component we call RokDocs that uses markdown files hosted on GitHub to render the documentation pages:
github.com/rockettheme/docs
You can browse the documentation right on GitHub, make changes, merge pull requests etc. This means that we can easily get fixes and edits from our community and quickly merge them into the 'master' copy that gets automatically synced with the live RocketTheme site.
This is not a public component at this time because we do some things that are quite specific to our needs, for example with the image overlays. We have considered making this a product though if the demand was there.
Incidentally we also use this same system for the Gantry documentation:
www.gantry-framework.org/documentation
Hope this helps!
-
Time to create page: 0.094 seconds