Creating custom applications for internal use can be hard to maintain when the users operating it require instructions. Liferay’s internal teams found the current documentation tools in the wild to be insufficient.
Coupled with intimate knowledge of how internal business units worked and communicated, I built this documentation generator that would turn markdown into a live single page application documentation site.
Leveraging the power of Gulp and Angular, on every edit, the site is updated and categorized with the tools our team knows.
The challenge was creating something was both accessible and familiar with our developers that resulted in a product that marketers felt comfortable and confident using
Seeing a business need of having technical competence
Picking the best architecture for the job that would solve the app’s use cases
Writing and iterating the bullet-proof code necessary to run the application
Handles pull requests, issues, feature requests
Business units have competence on internal tools built by our team and disciplines our teams to think about documentation.