Therefore, I crafted the following list of requirements: Scalable and Durable What Should You Look for in a Documentation Solution?īefore rushing into a solution, I wanted to have some kind of plan. We’ve started Freemius about a year and a half ago, and we finally felt it was time to prioritize documentation. The focus should be all about validating assumptions and quick iterations, till you get to a satisfactory product-market fit. Having said that, when the product is in early stages, it doesn’t make sense to rush and document it. How We Secured Our WordPress Knowledge Base?ĭocumentation was always on our TODOs list since the early days of Freemius.How We Customized the KB Search to Serve Cached Data?.How We Made Our WordPress Knowledge Base Super Fast?.Adding SyntaxHighlighter for Pretty Code.Adding Nice Callouts Shortcodes Support.Adding YouTube and Vimeo Markdown Support.
Choosing and Installing A Markdown WordPress Plugin.Using Markdown Instead of HTML Rich Editing.Making weDocs Mobile Friendly / Responsive.Adding A Pretty Homepage to The weDocs Knowledge Base.Customizing The Knowledge Base URL Structure (s).Adding Breadcrumbs Rich-Snippets Metadata.Installing and Customizing weDocs Documentation Solution.Why We Choose The weDocs WordPress Plugin for our Knowledge Base?.Why We Choose WordPress Over Static Site Generators for Our Knowledge Base.Why We Didn’t Choose Help Scout Docs or Any Other SaaSy Knowledge Base.Choosing The Right Documentation Platform is Hard!.What Should You Look for in a Documentation Solution?.If you are still not at the stage of setting up your own documentation center, just bookmark this page and come back when the time is right.
This 15-minute guide will save you 44 hours (we used time-tracking) of research, customization, testing and optimization. I’m sharing the complete cookbook of our research right here why we choose WordPress over SaaS solutions and static generators how we did it (including all code customizations and server level configuration), what we’ve learned, and how you can replicate that process to save valuable time, and set up your own lightning fast, scalable, sustainable, secure, and semi-static KB (Knowledge Base) for your own plugin, theme or any other digital product. TL DR: We finally built and released our semi-static, markdown based Knowledge Base for our monetization platform Freemius, using WordPress. If you aren’t a developer, you should probably send this article to your CTO. This is a comprehensive and technical step-by-step guide for developers. Setting up a solid Knowledge Base solution is an important long term investment, that hopefully, if done right, will pay off by reducing the support burden, widening your site’s SEO reach and generating new leads that otherwise wouldn’t have been landed. Once your startup’s user-base grows, support becomes a fundamental part of your business.
0 kommentar(er)
