Situation
This was a group class project for course TECM 5191 in Fall 2025. I was assigned to Group 2 with two other classmates. The project is to show a prospective client that our “company” (our team) can provide services using a component content management system, Madcap Flare, and a single source publishing platform, Central, to update content in their Hardware and Software manuals, obtain different deliverables, and allow multiple authors collaboration. Above screenshot shows the commits into Central.
Task
There were four tasks for this project. The first task is to organize the information and understand how Madcap Flare works. The second task is to get the content ready by working on topic-based and structured content authoring. For this task, I selected to create the concept template, while the other team members worked on the reference template and the task template. Above screenshot shows the concept template I made and the templates we organized as at team. The third task is to use the content to create the final deliverables. We followed one of my recommendations is to create a new folder to organize the contents easier before we create the table of contents. In addition, keywords and metadata descriptions were added for each chapter. We also worked on the CSS and styling. Our team split the contents to review and organize the table of contents. The fourth task is to submit a memo to the prospective client. I had worked on the first draft for the memo. Throughout the tasks, we had used Slack to communicate between the team members.
Action
For the first task, we have to organize the information by determining whether the information is a concept, task, or reference content. To be familiar with Madcap Flare and Central, we also commit and push content to Central from Madcap Flare and also pull content from Central to Madcap Flare.
For the second task, we worked on topic-based and structured content authoring by first categorizing content into DITA types and then create concept, task, and reference templates for each chapter of the manual. Topic-based authoring provides flexibility to use the topics for multiple deliverables for print and online (Perlin, 2021). One of our goals is to provide different deliverables in print and online formats to our prospective customer. The DITA content model for topics follow Jorsek’s set of rules or guidelines and the topics are separated into areas like task, reference, and concept (Heretto Inc., 2021). This provides a simple structure that will give end user easier way to search and read the topics. Using the respective templates, my team and I updated and rewrote content for the assigned chapters in the manuals. In addition, we added keywords and metadata descriptions for each chapter. Then, we commit and push content to Madcap Flare. In order to see the updated content from other team members, we have to pull data from Madcap Flare.
For the third task, we review the updated topic contents, worked on CSS and web design, and then we created an organized table of contents for three deliverables: a printed PDF, an online PDF, and an online access version. Above screenshot shows the TOC (Table of Contents) and Primary Targets.
For the fourth and final task, we drafted a memo to our prospective client advising them about the single source program Madcap Flare and persuading them to give the project to us.
On reflection of self-regulated learning, I used the Enhancing Interest Technique (Weinstein, C.E., Husman & Dierking 2000). I calmed and motivated myself to get the assignments done and worked step-by-step on finding answers to my questions and completing the project. I kept telling myself that “I can do this” and to mentally take on the challenge. Once I completed the assignment, it gave me a sense of accomplishment knowing how to work on a single source publishing program.
Result
The final deliverables submitted were a printed PDF, an online PDF, and an online access version. We also submitted a memo to our prospective client advising them about the single source program Madcap Flare and persuading them to give the project to us. Above screenshot shows a PDF build,
Madcap Flare is a single source program that many technical writers use. Upon completing this assignment, I am able to understand how multiple author collaboration works using single source programing software.
Bibliography
Heretto Inc. Technical Content Development Guide. Heretto Inc., 2021.
Perlin, N. (2021). Get a demo What Is Topic-Based Authoring? https://www.madcapsoftware.com/blog/what-is-topic-based-authoring/
Weinstein, C.E., Husman, J. and Dierking, D.R. (2000). “Self-regulation Interventions with a Focus on Learning Strategies,” Chapter 22, pp. 727-783. In Boekaerts, M., Pintrich, P. R., & Zeidner, M. (Eds.). Handbook of Self-regulation, 1st edition. Academic Press.