All entries for Software documentation

Developing Software on a Beer Mat

by Ann-Cathrin Mackenthun on September 25, 2012

In agile software development we no longer create lengthy functional specifications or product requirements. We write our requirements as short user stories that could easily fit on a note card or a beer mat. Software requirements on a beer mat? How can they possibly make sense to the developer or the technical writer? more...

Documentation for Software Engineers

by Ulrike Parson on November 15, 2011

Writing technical documentation for software engineers is more than authoring code comments. In order to use an application programming interface (API) or existing source code effectively, software engineers require different types of information. For this reason, technical writers who author API documentation need to analyze the requirements of their target group. more...