WordPress for Technical Documentation
•
2 likes•2,943 views
I talked about how we can use WordPress to develop a product knowledgebase. Being an open source CMS, WorrdPress gives us log of flexibility to plan custom content types, use taxonomy and contextual references, to plan a custom Knowledgebase.
Recommended
Recommended
More Related Content
Viewers also liked
Viewers also liked (15)
More from Vinish Garg
More from Vinish Garg (8)
Recently uploaded
Recently uploaded (20)
WordPress for Technical Documentation
- 1. 1 1 of 25 WordPress For Technical Documentation Text Vinish Garg TCWorld India Conference 2013, Bangalore.
- 2. 1 2 WordPress For Technical Documentation Prevalence • Traditional Help Authoring Tools • Xml Editors • Others – MS Word, SharePoint, HTML/CSS Text Vinish Garg TCWorld India Conference 2013, Bangalore.
- 3. 1 3 WordPress For Technical Documentation Why • Free, Open Source • Large Community, Huge Support • Affordable Prototyping • Modular Architecture and Hence Scalable • Advanced Custom Themes • Collaborative Authoring • Seamless User Generated Content Options • More…. Text Vinish Garg TCWorld India Conference 2013, Bangalore.
- 4. 1 4 WordPress For Technical Documentation WordPress! – An Opportunity or Misfit? Requirements! Basic? Desirable? Luxury? Text Vinish Garg TCWorld India Conference 2013, Bangalore.
- 5. 1 5 WordPress For Technical Documentation The SHIFT Key TOC, Topics, Search, Index See Also, Videos, Helpdesk User Generated Content, Version Control, Collaborative Authoring, Single Sourcing, Analytics, Social Media Integration Basic? Desirable? Text Vinish Garg TCWorld India Conference 2013, Bangalore.
- 6. 1 6 WordPress For Technical Documentation Out of Flavor! Writers. Programmers. • Automated: TOC, Search, Glossary, Index • Skills: No Programming • Zone: Comfort Zone Text Vinish Garg TCWorld India Conference 2013, Bangalore.
- 7. 1 7 WordPress For Technical Documentation The WP Flavor! Writers. Not Programmers Posts, Content Types, Collaborative Authoring, Taxonomy Customization, Analysis, User Generated Content, Custom Theming, Version Control, Social Media Integration Custom Content Types, Hundreds of Plug-Ins, Advanced User Statistics (Woopra), Enhanced UX (AJAX for Search), Integration with Helpdesk (Zendesk) Text Vinish Garg TCWorld India Conference 2013, Bangalore.
- 8. 1 8 WordPress For Technical Documentation Customer Case • About <U2ME> • Reference <SKYPE> Our Documentation • Platform <WP> Needs!!! • WP Architecture • Knowledgebase UI and UX • Content Text Vinish Garg TCWorld India Conference 2013, Bangalore.
- 9. 1 9 WordPress For Technical Documentation The Needs: 1-2 Custom Blocks Text Vinish Garg TCWorld India Conference 2013, Bangalore.
- 10. 10 WordPress For Technical Documentation The Needs: 3-4-n Text Vinish Garg TCWorld India Conference 2013, Bangalore.
- 11. 11 1 WordPress For Technical Documentation Value Free Content Participation Text Vinish Garg TCWorld India Conference 2013, Bangalore.
- 12. 12 1 WordPress For Technical Documentation High Level Requirements Help Topics, TOC (Categories, Taxonomy), Global Sections (Top Rated, Most Viewed), Custom Design, Standards Compliant, Advanced UX using AJAX (Search), Separate Rating (Topics and Videos), User Generated Content (Open Forums), YouTube API Integration, Database Integration with Product Database for User Authentication Text Vinish Garg TCWorld India Conference 2013, Bangalore.
- 13. 13 1 WordPress For Technical Documentation Rating Text Vinish Garg TCWorld India Conference 2013, Bangalore.
- 14. 14 WordPress For Technical Documentation Videos Text Vinish Garg TCWorld India Conference 2013, Bangalore.
- 15. 15 WordPress For Technical Documentation Related Topics Text Vinish Garg TCWorld India Conference 2013, Bangalore.
- 16. 16 WordPress For Technical Documentation TOC My Category Order S E Q U E N C E Text Vinish Garg TCWorld India Conference 2013, Bangalore.
- 17. 17 WordPress For Technical Documentation Search Enhanced UX using AJAX Text Vinish Garg TCWorld India Conference 2013, Bangalore.
- 18. 18 WordPress For Technical Documentation Version Control Text Vinish Garg TCWorld India Conference 2013, Bangalore.
- 19. 19 WordPress For Technical Documentation User Generated Content Text Vinish Garg TCWorld India Conference 2013, Bangalore.
- 20. 20 WordPress For Technical Documentation Others (In Scope) • Custom Theme • Analytics • SEO • Collaborative Authoring (role based CMS access) • Role Based Access (only authenticated users to contribute) • Advanced WYSIWYG Editor (custom classes drop-down) • Instant Control to Seek User Feedback or Comments • Version Control System Text Vinish Garg TCWorld India Conference 2013, Bangalore.
- 21. 21 WordPress For Technical Documentation More (Not In Scope) • Export to PDF (Standard) • Export to PDF (Conditional) • Archive Posts (Obsolete Features) • Using Variables (Template Parts) • Advanced Taxonomy Text Vinish Garg TCWorld India Conference 2013, Bangalore.
- 22. 22 WordPress For Technical Documentation Limitations • XML Support and DITA • Localization • Importing Project Files (Such as from RoboHelp) • Single Sourcing • Security • Reliance on Programmers’ Support Text Vinish Garg TCWorld India Conference 2013, Bangalore.
- 23. 23 WordPress For Technical Documentation A Final Note Me Too • No tool or platform is perfect • WordPress says *me too there* • Keep options open Text Vinish Garg TCWorld India Conference 2013, Bangalore.
- 24. 24 WordPress For Technical Documentation Credits • http://wp.tutsplus.com/tutorials/business/wordpress-as-a-knowledge-base/ • http://idratherbewriting.com/2009/02/08/merging-worlds-dita-and-wordpress/ • http://idratherbewriting.com/2013/01/21/how-to-import-webhelp-from-a-help-authoring-tool- into-wordpress/ • http://www.scriptorium.com/2013/01/2013-predictions-in-technical-communication/ • http://www.cherryleaf.com/blog/2011/10/new-software-that-might-interest-technical-authors/ • http://idratherbewriting.com/2011/12/09/technical-writing-in-the-cloud/ • http://idratherbewriting.com/2012/05/23/wikis-are-dead-other-options-for-collaboration/ • http://www.themeshaker.com/theme/knowledgedesk-wordpress-knowledge-base-theme Text Vinish Garg TCWorld India Conference 2013, Bangalore.
- 25. 25 Questions? • Email: vinish.garg@vhite.com • Business Website: http://www.vhite.com • Blog: http://www.enjoytechnicalwriting.com Vinish Garg • Phone: 91 98550 63463 • Twitter: vingar • LinkedIn: http://www.linkedin.com/in/vinishgarg • Location: Chandigarh, INDIA GMT +5:30 TCWorld India Conference 2013, Bangalore. Disclaimers and Copyrights This presentation is a copyright work of vhite systems. All artwork and graphics used in this document are the property of their respective owners, and its use is purely for non-commercial use, solely for this presentation purpose.