Docs-as-code workflows and tools

The Rocky Mountain Chapter of STC (STC RMC) serves the various needs of its members by:Promoting professionalism and the exchange of information among its membersEducating the community on the value of technical communicationThe Society for Technical Communication's diverse membership includes writers, editors, usability professionals, information architects, illustrators, printers, publishers, educators, students, engineers, and scientists employed in a variety of technological fields. With thousands of members worldwide, STC is the largest professional organization serving the technical communication profession.

Society for Technical Communication Rocky Mountain Chapter

<H2>Docs-as-code workflows and tools</H2>
If you plan to involve developers in writing and editing documentation, you might have more success by adopting the same tools developers use for software coding. This approach is often called "docs-as-code."
To treat docs like code generally means doing some of the following:
<UL>
<LI>
Working in plain text files (rather than binary file formats like FrameMaker or Word).
</LI>
<LI>
Using an open-source static site generator like Sphinx, Jekyll, or Hugo to build the files locally through the command line (rather than using a commercial program such as FrameMaker or Microsoft Word).
</LI>
<LI>
Working with files through an IDE such as Atom, Sublime, or another text editor (rather than relying on commercial tools with proprietary, closed systems that function like black boxes).
</LI>
<LI>
Storing docs in a version control repository (usually a Git repo) similar to how programming code is stored (rather than keeping docs in another space like SharePoint or a shared drive); also if appropriate, potentially storing the docs in the same repository as the code itself.
</LI>
<LI>
Collaborating with other writers using version control such as Git and GitHub to branch, merge, push, and pull updates (rather than collaborating through large content management systems or SharePoint-like check-in/check-out sites).
</LI>
<LI>
Automating the site build process with continuous delivery to build the web output from the server when you update a particular branch (rather than manually publishing and transferring files from one place to another).
</LI>
<LI>
Running validation checks using custom scripts to check for broken links, improper terms/styles, and formatting errors (rather than spot checking the content manually).
</LI>
</UL>
In short, treating docs like code means to use the same systems, processes, and workflows with docs as you do with programming code. In this presentation, we'll dive into each of these aspects of docs-as-code in depth and explore the advantages and disadvantages of the approach.
<DIV>
<H3>About the presenter</H3>
Tom Johnson is a technical writer for Amazon in Sunnyvale, California. He writes a popular blog on technical writing called Idratherbewriting.com, where he explores topics such as API documentation, trends, information design, and more. He also has an extensive online course on API documentation (<A HREF="http://idratherbewriting.com/learnapidoc/" TARGET="_blank" DATA-MSYS-CLICKTRACK="0" REL="nofollow noopener noreferrer">http://idratherbewriting.com/learnapidoc/</A>) that includes extensive tutorials and other exercises you can follow to build your expertise with APIs, including the OpenAPI specification, Swagger, and more.
</DIV>
<H3>What are my transportation/parking options for getting to and from the event?</H3>
Far and away the easiest way to find the classroom is to take the light rail to the Auraria at Colfax stop. (This is only a few stops from the Broadway park and ride if you're coming from the south.) When you get off the light rail, you walk a few hundred yards into campus and the Central classroom building is on your right. It's the building with the covered walkway above the outdoor path. If you don't take the light rail, then please make sure you download and look at the <A HREF="https://msudenver.edu/maps/" TARGET="_blank" DATA-MSYS-CLICKTRACK="0" REL="nofollow noopener noreferrer">campus map</A> before coming. Google maps directions will not take you to the correct building. There is a $4 charge for parking in any campus parking lot. The nearest parking lot to the Central classroom is the <A HREF="https://goo.gl/maps/aKdnu3ZeUTo" TARGET="_blank" DATA-MSYS-CLICKTRACK="0" REL="nofollow noopener noreferrer">Nutmeg lot</A> [Google Map link], which is about a two minute walk from the classroom. From this lot, walk west, along St. Francis Way, towards the roundabout. From the roundabout, walk west on Champa street (away from Speer). The central classroom building has one door in the alley, facing East, and one on 10th street plaza, facing South.
 The Tivoli parking garage is about a 10 minute, 1/2 mile walk from Central classroom. Directions from the garage to Central Classroom:
<A HREF="https://goo.gl/maps/WUh1GREuv5z" TARGET="_blank" DATA-MSYS-CLICKTRACK="0" REL="nofollow noopener noreferrer">https://goo.gl/maps/WUh1GREuv5z</A>
Walk South East (away from Auraria Parkway) along the 10th street plaza. Continue past the library, to Curtis street. If you reach Champa street, you have gone too far.

Metropolitan State University of Denver: Room CN 113

Our {communityGuidelinesLink} describe the sort of content we prohibit on Eventbrite. If you suspect an event may be in violation, you can report it to us so we can investigate.

To report other categories of prohibited or illegal content, submit {link}

Docs-as-code workflows and tools

More events from Society for Technical Communication Rocky Mountain Chapter

Discover more events from Society for Technical Communication Rocky Mountain Chapter, from Business to other experiences you might love.

Still looking for the right event?

Explore all events in Denver and filter by date, category, and more to find the perfect fit.

Docs-as-code workflows and tools

More events from Society for Technical Communication Rocky Mountain Chapter

Discover more events from Society for Technical Communication Rocky Mountain Chapter, from Business to other experiences you might love.

More Business events

Browse more Business events with different dates, prices, and formats to find your next great experience.

Still looking for the right event?

Explore all events in Denver and filter by date, category, and more to find the perfect fit.