System & technical documentation
Samples of technical and system documentation in my portfolio
API documentation
Like many companies, Code42 has an API to facilitate integration of its data into other tools and services and allow for automation. Part of my role was to create and update API documentation for the teams I supported. For me, this meant working closely with my SME, a developer on the team supporting Alerts, to … Continue reading “API documentation”
“Copy to clipboard” button development
A number of Code42’s support articles contain comprehensive API command or implementation script samples, but these samples were contained in <pre></pre> blocks that were difficult for users to easily copy. We needed a less error-prone way to deliver example content to users that they could then quickly incorporate into their own tasks, workflows, and implementations. … Continue reading ““Copy to clipboard” button development”
HTML justification
At The Hartford, business user procedures were written in Microsoft Word and published to the central library in .PDF. Although accessed through a web browser, the .PDFs took a significant amount of time to open on the user’s machine, a delay that is critical for call center users (whose performance is measured by a number … Continue reading “HTML justification”
IRAdirect system documentation
One of my early assignments as a consultant involved documenting a complex IRA management system. Because a large number of developers working on this system were also consultants, project managers feared losing that knowledge as consultants rolled off the project and also needed a quick way to bring new developers up to speed. A large … Continue reading “IRAdirect system documentation”