For this single source authoring project, I worked with multiple collaborators in MadCap Flare to create a proof of concept for a tech company’s hardware and software installation guides as PDFs and a searchable HTML output. We created a proof of concept that included edits to existing content and target outputs of chapter one for the hardware and software guides as well as an appendix from each. During this project, I exercised knowledge and skills in DITA-inspired, topic-based authoring; templating topics, single source authoring; technical editing; and target creation through MadCap Flare and MadCap Central.
MadCap Flare
Single Source Content Authoring
I used MadCap Flare to arrange standalone topics for the purpose of single source authoring. Using tags, I allocated topics to different targets –blue for PDF and red for searchable HTML. The image demonstrates the use of the MadCap Flare content organizer and the colored tags to indicate target outputs.
DITA
Topic-Based Content
Using DITA structures, I edited content to comply with DITA-inspired templates for concepts, references, and tasks. Keeping to these structures allowed for dynamic editing and streamlined target creation. The image demonstrates the use of the template with added keywords.
Searchable HTML
Single Source Targets
Using MadCap Flare for authoring, editing, and adding metadata, I built and published this single source target as a searchable HTML output with a side navigation that can be used to search for key terms in the document. The image here demonstrates a search of the keyword “chassis.”