Knowledge base articles
Semantic Wikis. Or How Malta Became Semantic
Recently I read a wiki article about Malta. My friend Sarah wrote it. I knew Malta was a small island. I knew it was in the Mediterranean. What I did not know was that Malta was one of the smallest states in the world. I also learned that the capital of Malta is Valletta. Naturally I concluded that Valletta was located in Malta. Most of us would. Computers would not. Because the wiki article was not machine-interpretable. It had no semantic capabilities. more...
Terminology Management Systems
Inconsistent use of terminology makes it more difficult to communicate in an organization. It also leads to misunderstandings. A terminology management system can solve this problem. The software manages all your company-specific terms and improves communication. Employees have access to an always up-to-date corporate terminology and can even participate in defining new terms. more...
Developing Software on a Beer Mat
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
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...