|
Technical Documentation
Technical documentation is a generic term for the classes of information created to describe (in technical language) the use, functionality or architecture of a product, system or service. Classes of technical documentation Classes of technical documentation may include: * patents * specifications of item or of components/materials * data sheets of item or of components/materials * test methods * manufacturing standards * system requirements * system architecture * system design documents and data including those necessary for the system development, testing, manufacturing, operation and maintenance Standardizing technical documentation Historically, most classes of technical documentation lacked universal conformity (standards) for format, content and structure. Standards are being developed to redress this through bodies such as the International Organization for Standardization(ISO), which has published standards relating to rules for preparation of user guides, manuals, pro ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Information
Information is an abstract concept that refers to that which has the power to inform. At the most fundamental level information pertains to the interpretation of that which may be sensed. Any natural process that is not completely random, and any observable pattern in any medium can be said to convey some amount of information. Whereas digital signals and other data use discrete signs to convey information, other phenomena and artifacts such as analog signals, poems, pictures, music or other sounds, and currents convey information in a more continuous form. Information is not knowledge itself, but the meaning that may be derived from a representation through interpretation. Information is often processed iteratively: Data available at one step are processed into information to be interpreted and processed at the next step. For example, in written text each symbol or letter conveys information relevant to the word it is part of, each word conveys information rele ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Medical Device
A medical device is any device intended to be used for medical purposes. Significant potential for hazards are inherent when using a device for medical purposes and thus medical devices must be proved safe and effective with reasonable assurance before regulating governments allow marketing of the device in their country. As a general rule, as the associated risk of the device increases the amount of testing required to establish safety and efficacy also increases. Further, as associated risk increases the potential benefit to the patient must also increase. Discovery of what would be considered a medical device by modern standards dates as far back as c. 7000 BC in Baluchistan where Neolithic dentists used flint-tipped drills and bowstrings. Study of archeology and Roman medical literature also indicate that many types of medical devices were in widespread use during the time of ancient Rome. In the United States it wasn't until the Federal Food, Drug, and Cosmetic Act (F ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Technical File
A technical file is a set of documents that describes a product and can prove that the product was designed in accordance with the requirements of a quality management system. All products that have a CE mark must have a technical file which must contain the information that proves that the product conforms with the EU directives and regulations for CE-marked products. EU enforcement authorities may demand a copy of the technical file for many years after the last product was made. Customers do not usually have access to the technical file. Content A technical file is usually based on a document archive system that ensures longevity of documents and can either be on paper or in electronic files. It can include drawings, specifications, reports, review records, meeting minutes, labels, instructions for use, software source code, production process flow charts, etc. One document may be named "technical file" and list all other documents that are considered part of the technical fil ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Technical Editing
Editing is the process of selecting and preparing written, photographic, visual, audible, or cinematic material used by a person or an entity to convey a message or information. The editing process can involve correction, condensation, organisation, and many other modifications performed with an intention of producing a correct, consistent, accurate and complete piece of work. The editing process often begins with the author's idea for the work itself, continuing as a collaboration between the author and the editor as the work is created. Editing can involve creative skills, human relations and a precise set of methods. There are various editorial positions in publishing. Typically, one finds editorial assistants reporting to the senior-level editorial staff and directors who report to senior executive editors. Senior executive editors are responsible for developing a product for its final release. The smaller the publication, the more these roles overlap. The top editor ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Technical Communication
Technical communication is used to convey scientific, engineering, or other technical information. Individuals in a variety of contexts and with varied professional credentials engage in technical communication. Some individuals are designated as technical communicators or technical writers. These individuals use a set of methods to research, document, and present technical processes or products. Technical communicators may put the information they capture into paper documents, web pages, computer-based training, digitally stored text, audio, video, and other media. The Society for Technical Communication defines the field as any form of communication that focuses on technical or specialized topics, communicates specifically by using technology, or provides instructions on how to do something.What is Technical Communicatio ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Network Documentation
Network documentation is a form of technical documentation. It is the practice of maintaining records about networks of computers. The documentation is used to give administrators information about how the network should look, perform and where to troubleshoot problems as they occur. Essential Parts of Network Documentation As the purpose of network documentation is to keep networks running as smoothly as possible while minimizing downtime when repairs are necessary, essential parts of network documentation include: *Map of the entire network to include locations of hardware and the cabling that connects the hardware *Server information such as data on the individual servers, schedules and locations of backups *Software information such as current versions, dates, licensing and support *Vendor and contractor information *Service agreements *Detailed record of problems and solutions: dated along with procedures and results Notation that helps administrators remember key detail ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Method Engineering
Method engineering in the "field of information systems is the discipline to construct new methods from existing methods".F. Harmsen & M. Saeki (1996). "Comparison of four method engineering languages". In: Sjaak Brinkkemper et al. (eds.) ''Proceedings of the IFIP TC8, WG8.1/8.2 working conference on method engineering on Method engineering : principles of method construction and tool support: principles of method construction and tool support''. January 1996, Atlanta, Georgia, United States. p.209-231 It focuses on "the design, construction and evaluation of methods, techniques and support tools for information systems development". Furthermore, method engineering "wants to improve the usefulness of systems development methods by creating an adaptation framework whereby methods are created to match specific organisational situations".Colette Rolland (2008''Method Engineering: Towards Methods as Services'' Keynote speech ICSE0. 2008. Types Computer aided method engineeri ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Document Management System
A document management system (DMS) is usually a computerized system used to store, share, track and manage files or documents. Some systems include history tracking where a log of the various versions created and modified by different users is recorded. The term has some overlap with the concepts of content management systems. It is often viewed as a component of enterprise content management (ECM) systems and related to digital asset management, document imaging, workflow systems and records management systems. History Beginning in the 1980s, a number of vendors began to develop software systems to manage paper-based documents. These systems dealt with paper documents, which included not only printed and published documents, but also photographs, prints, etc. Later developers began to write a second type of system which could manage electronic documents, i.e., all those documents, or files, created on computers, and often stored on users' local file-systems. The earliest elect ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
ReStructuredText
reStructuredText (RST, ReST, or reST) is a file format for textual data used primarily in the Python programming language community for technical documentation. It is part of the Docutils project of the Python Doc-SIG (Documentation Special Interest Group), aimed at creating a set of tools for Python similar to Javadoc for Java or Plain Old Documentation (POD) for Perl. Docutils can extract comments and information from Python programs, and format them into various forms of program documentation. In this sense, reStructuredText is a lightweight markup language designed to be both (a) processable by documentation-processing software such as Docutils, and (b) easily readable by human programmers who are reading and writing Python source code. History reStructuredText evolved from an earlier lightweight markup language called StructuredText (developed by Zope). There were a number of problems with StructuredText, and reST was developed to address them. The name reStructuredText w ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
S1000D
S1000D is an international specification for the procurement and production of technical publications. It is an XML specification for preparing, managing, and publishing technical information for a product. It was initially developed by the AeroSpace and Defence Industries Association of Europe (ASD) for use with military aircraft. Since Issue the scope has been extended to include land, sea and even non-equipment products. It is widely used in civil as well as military products. S1000D is part of the S-Series of ILS specifications. S1000D is maintained by the S1000D Steering Committee, which includes board members from ASD, the United States' Aerospace Industries Association (AIA), and the Air Transport Association (ATA), along with industry and defence representatives from most of the countries currently using the specification. The specification is free to download and use, although commercial products and services are available.. Main principles S1000D requires information to ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
DocBook
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. As a semantic language, DocBook enables its users to create document content in a presentation-neutral form that captures the logical structure of the content; that content can then be published in a variety of formats, including HTML, XHTML, EPUB, PDF, man pages, Web help and HTML Help, without requiring users to make any changes to the source. In other words, when a document is written in DocBook format it becomes easily portable into other formats, rather than needing to be rewritten. Design DocBook is an XML language. In its current version (5.x), DocBook's language is formally defined by a RELAX NG schema with integrated Schematron rules. (There are also W3C XML Schema+Schematron and Document Type Definition (DTD) versions of the schema available, but ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
