Automating software documentation: a case study

  • Authors:
  • Miki Magyar

  • Affiliations:
  • Spatial Technology Inc, Boulder, Colorado

  • Venue:
  • IPCC/SIGDOC '00 Proceedings of IEEE professional communication society international professional communication conference and Proceedings of the 18th annual ACM international conference on Computer documentation: technology & teamwork
  • Year:
  • 2000

Quantified Score

Hi-index 0.00

Visualization

Abstract

Spatial Technology, Inc., has 45-60 developers (depending on how you count) busy writing code. The Tech Pubs department has three writers to keep up with them, plus two programmers who develop and maintain software tools that support the documentation. This team puts out paper and online documentation, on time, reasonably complete, for one major and several minor releases a year. It's the tools that make it possible.I will first describe the tools and processes in place when I started at Spatial, explain the issues that led us to change them, and discuss the changes that we put in place both for tools and process. I will also discuss some of the problems we faced and how we dealt with them. In the presentation, I will report on the current state of the transition, and explore how this specific case study could be a useful model for dealing with complex software documentation projects.