Friday, October 9, 10am–12pm CDT. Prior registration required. Registrants have been sent Zoom link separately.
The conceptual overlap in the Venn diagram between the engineering and technical communication communities is rich with untapped opportunities. Code, for example, could be considered a dividing wall over which either side rarely traverses. One door through which both sides could enter is the ansible language of YAML. Since YAML, which stands for YAML ain’t markup language, was introduced in 2001 it has become one of the tools front end engineers use to store information and help build data driven user interfaces. As academics seeking to engage technically inclined tech comm students and engineers curious about code efficiency, YAML is a way to communicate information architecture and further solidify the relationship between the software engineering and technical communication disciplines. As professionals, YAML is a tool that allows engineers and technical communicators an opportunity to gain a higher shared understanding of the role each plays in software development. I propose a workshop that does the following:
Allows attendees to develop simple YAML code during the workshop.
- Explain the history of YAML
- Discuss YAML’s business applications
- Define YAML methodology and basics commands
- Create simple exercises for YAML execution in a code environment
Develop a curriculum that uses YAML to communicate information design and usability.
- Discuss YAML within the framework of information design and expand its applications in electronic media
- Identify the materials and resources needed to understand, create and execute YAML files
- Develop individual and team exercises that promote the analysis of YAML methodologies using information design and usability concepts for technical communication professionals and software engineers
Introduces talking points academics and professional can use to introduce YAML and similar tools into the classroom and workplace.
- Code protection – YAML allows work with data driven components of the software to be manipulated away from actual code.
- Agile technical writers – The addition of YAML as a skill set furthers the writer’s understanding of software logic and the ability to provide robust internal documentation.
- Engineers – YAML becomes another tool to promote inclusivity between engineers and the technical communication community.
- Information Design and Usability – The analysis of the presentation of information within a code environment can have a positive effect on code efficiency and the role of technical communication as a discipline.
Attendees should leave the workshop with a understanding of YAML and tools to introduce YAML concepts in their respective work environments.
No Comments