Related Research Articles
DocBook is a semantic markup language for technical documentation. It was originally intended for writing technical documents related to computer hardware and software, but it can be used for any other sort of documentation.
Adobe FrameMaker is a document processor designed for writing and editing large or complex documents, including structured documents. It was originally developed by Frame Technology Corporation, which was bought by Adobe.
A content management system (CMS) is computer software used to manage the creation and modification of digital content . A CMS is typically used for enterprise content management (ECM) and web content management (WCM).
The Organization for the Advancement of Structured Information Standards is a nonprofit consortium that works on the development, convergence, and adoption of projects - both open standards and open source - for Computer security, blockchain, Internet of things (IoT), emergency management, cloud computing, legal data exchange, energy, content technologies, and other areas.
A technical writer is a professional information communicator whose task is to transfer information between two or more parties, through any medium that best facilitates the transfer and comprehension of the information. Technical writers research and create information through a variety of delivery media. Example types of information include online help, manuals, white papers, design specifications, project plans, and software test plans. With the rise of e-learning, technical writers are increasingly becoming involved with creating online training material.
Web development is the work involved in developing a website for the Internet or an intranet. Web development can range from developing a simple single static page of plain text to complex web applications, electronic businesses, and social network services. A more comprehensive list of tasks to which Web development commonly refers, may include Web engineering, Web design, Web content development, client liaison, client-side/server-side scripting, Web server and network security configuration, and e-commerce development.
Technical writing is the writing of technical content, particularly relating to industrial and other applied sciences, with an emphasis on occupational contexts. The range of audiences for technical writing varies widely. In some cases, it is directed to people with specialized knowledge, such as experts or technicians. In other situations, technical writers help convey complex scientific or niche subjects to end users who need a basic understanding of a concept rather than a full explanation of a subject. Technical writing is the largest part of technical communication.
Technical communication is communication of technical subject matter such as engineering, science, or technology content. The largest part of it tends to be technical writing, though importantly it often requires aspects of visual communication. Technical communication also encompasses oral delivery modes such as presentations involving technical material. When technical communication occurs in workplace settings, it's considered a major branch of professional communication. In research or R&D contexts, it can overlap with scientific writing.
The Darwin Information Typing Architecture (DITA) specification defines a set of document types for authoring and organizing topic-oriented information, as well as a set of mechanisms for combining, extending, and constraining document types. It is an open standard that is defined and maintained by the OASIS DITA Technical Committee.
Task analysis is a fundamental tool of human factors engineering. It entails analyzing how a task is accomplished, including a detailed description of both manual and mental activities, task and element durations, task frequency, task allocation, task complexity, environmental conditions, necessary clothing and equipment, and any other unique factors involved in or required for one or more people to perform a given task.
Single-source publishing, also known as single-sourcing publishing, is a content management method which allows the same source content to be used across different forms of media and more than one time. The labor-intensive and expensive work of editing need only be carried out once, on only one document; that source document can then be stored in one place and reused. This reduces the potential for error, as corrections are only made one time in the source document.
JoAnn T. Hackos is a lecturer, consultant, and author of a number of books about technical communication. Now retired, Hackos is the founder of the Center for Information-Development Management (CIDM) and the president emeritus of Comtech Services in Denver, Colorado. She is also a fellow and past president of the Society for Technical Communication. She is a member of the IEEE Standards Association and active in the ISO SC7 Working Groups that is developing standards for information developers. She is the co-author of the standards on content management and information-development management.
Microsoft Assistance Markup Language is an XML-based markup language developed by the Microsoft User Assistance Platform team to provide user assistance for the Microsoft Windows Vista operating system. It makes up the Assistance Platform on Windows Vista.
User experience design defines the experience a user would go through when interacting with a company, its services, and its products. User experience design is a user centered design approach because it considers the user's experience when using a product or platform. Research, data analysis, and test results drive design decisions in UX design rather than aesthetic preferences and opinions. Unlike user interface design, which focuses solely on the design of a computer interface, UX design encompasses all aspects of a user's perceived experience with a product or website, such as its usability, usefulness, desirability, brand perception, and overall performance. UX design is also an element of the customer experience (CX), and encompasses all aspects and stages of a customer's experience and interaction with a company.
Ann Rockley is a content manager. She is the founder and President of The Rockley Group, based in the greater Toronto Area. She regularly presents papers and workshops on subjects involving the efficient creation, management and delivery of content for organizations in North America and Europe. She was the lead analyst for The XML & Component Content Management Report on Content Management Systems Watch.
MadCap Software is an American computer software firm headquartered in San Diego, California that creates help authoring tools and solutions for technical writers and documentation teams. Several principal managers, software engineers, and support personnel were recruited from rival firms, such as Adobe Systems and Macromedia, to found MadCap Software. MadCap's authoring tools are all based on xHTML.
Minimalism in structured writing, topic-based authoring, and technical writing in general is based on the ideas of John Millar Carroll and others. Minimalism strives to reduce interference of information delivery with the user's sense-making process. It does not try to eliminate any chance of the user making a mistake, but regards an error as a teachable moment that content can exploit.
Structured writing is a form of technical writing that uses and creates structured documents to allow people to digest information both faster and easier. From 1963 to 1965, Robert E. Horn worked to develop a way to structure and connect large amounts of information, taking inspiration from geographical maps. He coined the term "Information Mapping" to describe his method of analyzing, organizing, and displaying knowledge in print and in the new online presentation of text and graphics.
Technical documentation is a generic term for the classes of information created to describe the use, functionality or architecture of a product, system or service.
A component content management system (CCMS) is a content management system that manages content at a granular level (component) rather than at the document level. Each component represents a single topic, concept or asset.
References
- ↑ Norman Walsh (5 February 2007). "Topic-oriented authoring". norman.walsh.name. Retrieved 21 June 2012.
- ↑ Rockley, Ann; Manning, Steve; Cooper, Charles (2009). DITA 101: fundamentals of DITA for authors and managers. Schomberg, ON: The Rockley Group. ISBN 978-0-557-07291-0.
- ↑ Cleary, Yvonne (2020-01-31), "Teaching Topic-based Writing", Teaching Content Management in Technical and Professional Communication, New York, NY : Routledge, 2020. | Series: ATTW book series in technical and professional communication: Routledge, pp. 72–86, ISBN 978-0-429-05961-2 , retrieved 2023-11-10
{{citation}}: CS1 maint: location (link) - ↑ Carroll, John M., ed. (1998). Minimalism beyond The Nurnberg Funnel. Cambridge: MIT Press. ISBN 978-0-262-51295-4.
- ↑ Horton, William K. (1990). Designing and writing online documentation: hypermedia for self-supporting products. Wiley technical communication library (2nd ed.). New York, NY: Wiley. ISBN 978-0-471-30635-1.
