Currently, visual XML structured authoring applications can typically handle a small number of XML vocabularies. In some cases, they can even handle them in limited nested scenarios. One of the purposes of creating XML documents with compound vocabularies is to present related information on a given topic in different manners (tables, charts, etc). The synchronization of views between objects of different vocabularies in real-time editing helps authors realize this potential. In this presentation we will discuss an approach to visually creating, editing and synchronizing, nested compound XML vocabularies within one document. The open nature of the architecture enables developers to create plug-ins for new vocabularies including the ability to define synchronization. Also this architecture provides simple method to define visualization of a new vocabulary by utilizing plug-ins already developed and activated.
Every web designer should know and understand a Web site’s parameters before lifting a finger to start designing the site. In this article, you will learn the basics required to start designing business Web sites. While this information is useful if you want to build sites for others, it can also serve as a checklist article for sites you want to build for yourself.
Rather than spend hours coming up with a complex numbering scheme, this might be an excuse to implement something far more straightforward discovered by an extensive readability study at IBM, of which I was a part. My work involved sitting behind a one-way mirror with a stopwatch, watching people take tests that involved, among other things, "how fast can you find Figure 3-4?" We had cameras mounted over the participant's shoulders and could watch them thumb through the documents, and we also monitored eye movements. Then we followed up with a short interview where we got feedback.
Companies had decades of experience in using printed materials to persuade readers to contact them, whether by phone, mail, or in person. This model of interaction with customers had worked so well and so predictably that we simply moved it online, largely unmodified. That was by no means wrong, but as Web technology and our comprehension of that technology both evolved, the approach proved limiting.
You’re told that you need to move your content to XML. You have loads and loads of unstructured content. It’s in FrameMaker, Word, other desktop publish applications, or even more fun: it’s on paper.
It's hard to look at a page of text and try to decide where to divide things to create individual topics. That "bottom up" approach is kind of pointless, in fact. There are better ways.
One of the hottest topics these days in Information Architecture circles is documentation. This is probably partly because the IA's role is so ill defined. Our jobs sit perched between engineering and graphic design: go too far in one direction, we're doing the coding, go to far in the other and we are doing the design. Neither role maximizes the architect's key skills; defining the organizational structure and behavior of the web site or application. An IA is most effective when they leave implementation and final graphic design out of the mix. The documents they create to express this have to be crafted with equal skill and diplomacy.
Lately I’ve been creating context-sensitive help for an online application. As part of my strategy, I’ve been trying to follow Theresa Putkey’s advice in “Usability in Context-Sensitive Help.” In her article, Theresa recommends providing more than just the steps for a specific task in the context-sensitive help window. Instead, she says to show more contextual links, including answers to why, when, and who questions, because too frequently the user who searches for help may have needs outside the specific task you describe.
DITA is applicable to many publishing applications, including traditional narrative documents that don't seem, at first look, like candidates for ditification.
Two powerful trends in tech comm seem to be moving in different directions: social media and structured authoring. I have used a wiki as my primary format for documentation for the past year and a half. I tried to corral a group of volunteer technical writers to edit and update the wiki, because I embraced the idea that collective intelligence beats the individual thinker in the long run. But even the most advanced wikis don’t have a structured authoring backend.
The issue of documenting schemas—or any machine readable language—goes beyond simple additions of comments. Thereal challengeistocreateschemasthat arereadablebothdirectlybylookingat their sourcecodeandbydocumentation extraction tools.
The way I learned to write documentation was that you started work on a new project by spending a decent amount of time getting to know your subject matter. I don't mean getting to know the software, I mean getting an understanding of the environment in which the software will be used and the reason for its existence - that is: what's the real value of the software to its users and what do they want to achieve by using it?
The accessibility of written information becomes an increasingly relevant issue in today's information-dense society. Although headings are generally known to signal textual content and thus aid access, it remains unclear how frequently headings should be used for optimal document use. Information Mapping© is a text writing method that systematically splits up text in chunks accompanied by headings. The present paper presents a study in which a print health education document was varied systematically in accordance with the Information Mapping method, to examine the effects of heading frequency and information order on participants' search speed and their evaluation of the text layout. Results showed that the presence of headings in a text indeed contributed to easier access in the search tasks. Although no differences in search speed were found with varying numbers of headings in the text, some subjective opinions were in favour of the version with most headings. The different information order of the Information Mapping text had no effect.
The intent of Sarbanes-Oxley (SOX) can be characterized as risk reduction: reduce errors, inhibit fraud, and provide shareholders with transparent equal-access to material knowledge. But implementation is principally procedural controls and documentation, under threat of penalty. The vague parts of SOX are where the real leverage lies: principles of intent, and corporate transparency.
In the city of Konstanz on the shores of Lake Constance, Siemens AG manufactures equipment for sorting post. Also at the same location, a team of 16 experts create the corresponding technical documentation. But their work is not restricted to handbooks and CDs. Since ten years, this department, called 'Technical Media', has also been taking care of multimedia and training.
The structure of print and on-screen documents is made explicit through headings and links. Three important concepts for understanding explicit structure are (1) the display-unit properties of each document medium, (2) the flexible relationship between explicit and implicit structure, and (3) the distinction between populated and unpopulated locations in a hierarchy. These concepts help us better understand standard print documents, structured writing, websites, help systems, and PowerPoint, as well as the potential effects of content management systems on how documents are created.
Technical communicators have become increasingly interested in how to 'open up' the documentation process - to encourage workers to participate in developing documentation that closely fits their needs. This goal has led technical communicators to engage in usability testing, user-centered design approaches, and, more recently, open source documentation. Although these approaches have all had some success, there are other ways to encourage the participatory citizenship that is implied in these approaches. One way is through an open systems approach in which workers can consensually modify a given system and add their own contributions to the system.
Perhaps our headings should focus a bit more on user benefits? For example, "Overview of batch printing - Save time and improve document organization" is a bit more engaging, especially if your customer is struggling with those issues.
One of my goals was to make it easy to get help for using specific parts of our application. Users don’t need to know the name of the panel or feature they are trying to use. They just need to know where they are working on the screen, and they can click through to get the help that discusses that part of the screen.
Information Mapping is a proprietary method for the analysis, organisation, and presentation of information. It is based on the needs of the users and their purpose in using the documentation. Information Mapping has three parts: analysis, organisation, presentation.
Creating an information plan should be the first phase of any publication development life cycle, whether hard copy or online. The plan is a tool for reporting the results of your research about your audience, their tasks, the market, and the product. The plan presents the basic organization and content of the publications you intend to build, effectively directing the documentation team to produce a publication with very specific goals in mind.
The primary aim of the research presented in this paper is to provide pragmatic solutions to the problems of integrity and consistency of document based information, describing a building throughout its life cycle. The research demonstrates the computer-aided generation of project documents via a construction project data model. The first research activity involved the development of a Construction Project Reference Model (CPRM) and a Document Reference Model, from which various Applied Document Type Models can be derived. The work concentrated on the French Full Specification Document: the CCTP (Cahier des Clauses Techniques ParticuliÃ¨res), which is generated during the detail design stage. A generic Association Model was developed and used to index the CPRMâ€™s concepts to the CCTPâ€™s documentary elements supporting their description. Finally, the mechanisms enabling the generation of the project CCTP from the proposed structured reference CCTP are described.
The use of physical paper or digital files is not an either/or choice. The two are complementary. Currently, there are many examples of paper used as an interface to digital processes. The UPC found on items we buy and the barcoded labels on the packages we send are two prevalent examples. Many papers we use to reach our customers or to do our work within our organizations have at least one barcode.