Here you can download graphics, articles, and presentations explaining various aspects of technical writing and web development. Please contact us with any comments or questions you may have about the downloads.
The downloads are PDF files that you can read by using the free Adobe Reader.
WebWorks ePublisher is a leading single-sourcing tool for converting Word, FrameMaker, and DITA documents to HTML and online help. AlmondWeb is a WebWorks reseller and offer WebWorks training, implementation, and support. Here are presentations demonstrating WebWorks capabilities and explaining how to design a WebWorks workflow.
CSS is the dominant style language for HTML and XML pages. Innumerable applications, ranging from web browsers and help systems to Microsoft Word and XML editors, use CSS to format and display text and graphics. This presentation explains how to use CSS in standalone style sheets, in inline HTML code, and in the context of help authoring tools such as WebWorks ePublisher.
A perennial favorite, the AlmondWeb Page Setup Guide is a graphic illustrating how to set up the Microsoft Word page layout for a printed book. The graphic shows how to compute the crop mark locations, margins, gutter, headers, and footers for a cut page centered on an uncut Letter or A4 page.
This is a light-hearted article illustrating the difference between the how and why styles of technical writing. How writing emphasizes procedures—what a user needs to do. Why writing emphasizes concepts—it's directed to experts, or to novices who want to become experts. The article may give you some tips about peeling potatoes, too!
API Documentation: How to Explain so Experts will Understand
AlmondWeb's director, David Shaked (Wernick), shares some insights on successful API documentation. These presentations introduce API documentation issues, such as writing for an expert audience, understanding object-oriented APIs, organizing the subject matter in learning and reference manuals, and documenting .NET APIs.
Did you ever wonder why tennis games are often so lopsided? Why a player who is a little better may win by an overwhelming score? A mathematically inclined AlmondWeb writer, who plays tennis, performed a probability analysis to find the answer. The results, by the way, illustrate an aspect of technical writing—presenting complex information by means of inter-related text, tables, and graphs.