|
Documentation
Documentation is any communicable material that is used to describe, explain or instruct regarding some attributes of an object, system or procedure, such as its parts, assembly, installation, maintenance, and use. As a form of knowledge management and knowledge organization, documentation can be provided on paper, online, or on digital or analog media, such as audio tape or CDs. Examples are user guides, white papers, online help, and quick-reference guides. Paper or hard-copy documentation has become less common. Documentation is often distributed via websites, software products, and other online applications. Documentation as a set of instructional materials shouldn't be confused with documentation science, the study of the recording and retrieval of information. Principles for producing documentation While associated International Organization for Standardization (ISO) standards are not easily available publicly, a guide from other sources for this topic may serve ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Documentation Science
Documentation science is the study of the wikt:recording, recording and Information retrieval, retrieval of information. It includes methods for storing, retrieving, and sharing of information captured on physical as well as digital documents. This field is closely linked to the fields of Library and information science, library science and information science but has its own theories and practices. The term documentation science was coined by Belgian lawyer and peace activist Paul Otlet. He is considered to be the forefather of information science. He along with Henri La Fontaine laid the foundations of documentation science as a field of study. Professionals in this field are called ''documentalists.'' Over the years, documentation science has grown to become a large and important field of study. Evolving from traditional practices like archiving and retrieval to modern theories about the nature of documents, novel methods for organizing digital information, and applications i ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Technical Writers
A technical writer is a professional communicator whose task is to convey complex information in simple terms to an audience of the general public or a very select group of readers. Technical writers research and create information through a variety of delivery media (electronic, printed, audio-visual, and even touch). 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 hired to develop online training material. According to the Society for Technical Communication (STC):L. Lin. (2017, November). What is technical writing? eb log post Retrieved from http://www.stc-psc.org/what-is-technical-writing/ In other words, technical writers take advanced technical concepts and communicate them as clearly, accurately, and comprehensively as possible to their intended audience, ensuring that the work is accessible to its users. Kurt Vonnegut d ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Man Page
A man page (short for manual page) is a form of software documentation found on Unix and Unix-like operating systems. Topics covered include programs, system libraries, system calls, and sometimes local system details. The local host administrators can create and install manual pages associated with the specific host. A manual end user may invoke a documentation page by issuing the man command followed by the name of the item for which they want the documentation. These manual pages are typically requested by end users, programmers and administrators doing real time work but can also be formatted for printing. By default, man typically uses a formatting program such as nroff with a macro package or mandoc, and also a terminal pager program such as more or less to display its output on the user's screen. Man pages are often referred to as an ''online'' form of software documentation, even though the man command does not require internet access. The environment variable M ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Subject-matter Experts
A subject-matter expert (SME) is a person who has accumulated great knowledge in a particular field or topic and this level of knowledge is demonstrated by the person's degree, licensure, and/or through years of professional experience with the subject. For example, a PhD in chemistry could be easily declared as a SME in chemistry, or a person with a Second Class Radiotelegraph License or equivalent issued by the national licensing body could be considered a SME in radiotelegraphy. A person with a master's degree in electronic engineering could be considered a subject-matter expert in electronics, or a person with many years of experience in machining could be considered a SME in machining. The term is used when developing materials about a topic (a book, an examination, a manual, etc.), and expertise on the topic is needed by the personnel developing the material. For example, tests are often created by a team of psychometricians and a team of SMEs. The psychometricians understa ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
International Organization For Standardization
The International Organization for Standardization (ISO ; ; ) is an independent, non-governmental, international standard development organization composed of representatives from the national standards organizations of member countries. Membership requirements are given in Article 3 of the ISO Statutes. ISO was founded on 23 February 1947, and () it has published over 25,000 international standards covering almost all aspects of technology and manufacturing. It has over 800 technical committees (TCs) and subcommittees (SCs) to take care of standards development. The organization develops and publishes international standards in technical and nontechnical fields, including everything from manufactured products and technology to food safety, transport, IT, agriculture, and healthcare. More specialized topics like electrical and electronic engineering are instead handled by the International Electrotechnical Commission.Editors of Encyclopedia Britannica. 3 June 2021.Inte ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Standing Operating Procedure
A standard operating procedure (SOP) is a set of step-by-step instructions compiled by an organization to help workers carry out routine operations. SOPs aim to achieve efficiency, quality output, and uniformity of performance, while reducing miscommunication and failure to comply with industry regulations. Some military services (e.g., in the U.S. and the UK) use the term standing operating procedure, since a military SOP refers to a unit's unique procedures, which are not necessarily standard to another unit. The word "standard" could suggest that only one (standard) procedure is to be used across all units. The term is sometimes used facetiously to refer to practices that are unconstructive, yet the norm. In the Philippines, for instance, "SOP" is the term for pervasive corruption within the government and its institutions. Clinical research and practice In clinical research, the '' International Council for Harmonisation'' (ICH) defines SOPs as "detailed, written instructio ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Online Help
Online help is a form of user assistance that provides topic-oriented, procedural or reference information designed to assist in using a software application, web application or operating system. Online help linked to the application's state (what the user is doing) is called Context-sensitive help. The help information can be created using help authoring tools or component content management systems and can be delivered in a wide variety of proprietary and open-standard formats. Help of this kind has largely replaced printed documentation. Interactive help can also be provided via virtual assistants and Chatbot systems. Microsoft help platforms Microsoft develops platforms for delivering help systems for the Microsoft Windows operating system. Other platforms See also * Balloon help * Darwin Information Typing Architecture *DocBook DocBook is a Semantics (computer science), semantic markup language for technical documentation. It was originally intended for wr ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
User Guide
A user guide, also commonly known as a user manual, is intended to assist users in using a particular product, service or application. It is usually written by a technician, product developer, or a company's customer service staff. Most user guides contain both a written guide and associated images. In the case of computer applications, it is usual to include screenshots of the human-machine interface(s), and hardware manuals often include clear, simplified diagrams. The language used is matched to the intended audience, with jargon kept to a minimum or explained thoroughly. Contents of a user manual The sections of a user manual often include: *A cover page *A title page and copyright page *A preface, containing details of related documents and information on how to navigate the user guide *A contents page *A Purpose section. This should be an overview rather than detail the objective of the document *An Audience section to explicitly state who is the intended audience who is ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Requirement
In engineering, a requirement is a condition that must be satisfied for the output of a work effort to be acceptable. It is an explicit, objective, clear and often quantitative description of a condition to be satisfied by a material, design, product, or service. A specification or spec is a set of requirements that is typically used by developers in the design stage of new product development, product development and by testers in their verification process. With iterative and incremental development such as agile software development, requirements are developed in parallel with design and implementation. With the waterfall model, requirements are completed before design or implementation start. Requirements are used in many engineering fields including engineering design, system engineering, software engineering, enterprise engineering, New product development, product development, and process optimization. Requirement is a relatively broad concept that can describe any nec ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Functional Specification
A functional specification (also, ''functional spec'', ''specs'', ''functional specifications document (FSD)'', ''functional requirements specification'') in systems engineering and software development is a document that specifies the functions that a system or component must perform (often part of a requirements specification) (ISO/IEC/IEEE 24765-2010). The documentation typically describes what is needed by the system user as well as requested properties of inputs and outputs (e.g. of the software system). A functional specification is the more technical response to a matching requirements document, e.g. the product requirements document "PRD". Thus it picks up the results of the requirements analysis stage. On more complex systems multiple levels of functional specifications will typically nest to each other, e.g. on the system level, on the module level and on the level of technical details. Overview A function (engineering), functional specification does not define the in ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Software Design
Software design is the process of conceptualizing how a software system will work before it is implemented or modified. Software design also refers to the direct result of the design process the concepts of how the software will work which consists of both design documentation and undocumented concepts. Software design usually is directed by goals for the resulting system and involves problem-solving and planning including both high-level software architecture and low-level component and algorithm design. In terms of the waterfall development process, software design is the activity of following requirements specification and before coding. General process The design process enables a designer to model various aspects of a software system before it exists. Creativity, past experience, a sense of what makes "good" software, and a commitment to quality are success factors for a competent design. However, the design process is not always a straightforward procedure ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
