Documentation

View this topic in
Documentation is a general term for a multiplicity of documents in a chosen mix of media and with a certain collection. (Wikipedia.org)






Conferences related to Documentation

Back to Top

2023 Annual International Conference of the IEEE Engineering in Medicine & Biology Conference (EMBC)

The conference program will consist of plenary lectures, symposia, workshops and invitedsessions of the latest significant findings and developments in all the major fields of biomedical engineering.Submitted full papers will be peer reviewed. Accepted high quality papers will be presented in oral and poster sessions,will appear in the Conference Proceedings and will be indexed in PubMed/MEDLINE.


2020 IEEE 18th International Conference on Industrial Informatics (INDIN)

INDIN focuses on recent developments, deployments, technology trends, and research results in Industrial Informatics-related fields from both industry and academia


2020 IEEE Frontiers in Education Conference (FIE)

The Frontiers in Education (FIE) Conference is a major international conference focusing on educational innovations and research in engineering and computing education. FIE 2019 continues a long tradition of disseminating results in engineering and computing education. It is an ideal forum for sharing ideas, learning about developments and interacting with colleagues inthese fields.


2020 IEEE IAS Petroleum and Chemical Industry Committee (PCIC)

The PCIC provides an international forum for the exchange of electrical applications technology related to the petroleum and chemical industry. The PCIC annual conference is rotated across North American locations of industry strength to attract national and international participation. User, manufacturer, consultant, and contractor participation is encouraged to strengthen the conference technical base. Success of the PCIC is built upon high quality papers, individual recognition, valued standards activities, mentoring, tutorials, networking and conference sites that appeal to all.


2020 IEEE International Symposium on Electromagnetic Compatibility & Signal/Power Integrity (EMCSI)

This symposium pertains to the field of electromagnetic compatibility.


More Conferences

Periodicals related to Documentation

Back to Top

Computational Biology and Bioinformatics, IEEE/ACM Transactions on

Specific topics of interest include, but are not limited to, sequence analysis, comparison and alignment methods; motif, gene and signal recognition; molecular evolution; phylogenetics and phylogenomics; determination or prediction of the structure of RNA and Protein in two and three dimensions; DNA twisting and folding; gene expression and gene regulatory networks; deduction of metabolic pathways; micro-array design and analysis; proteomics; ...


Computer

Computer, the flagship publication of the IEEE Computer Society, publishes peer-reviewed technical content that covers all aspects of computer science, computer engineering, technology, and applications. Computer is a resource that practitioners, researchers, and managers can rely on to provide timely information about current research developments, trends, best practices, and changes in the profession.


Computer Graphics and Applications, IEEE

IEEE Computer Graphics and Applications (CG&A) bridges the theory and practice of computer graphics. From specific algorithms to full system implementations, CG&A offers a strong combination of peer-reviewed feature articles and refereed departments, including news and product announcements. Special Applications sidebars relate research stories to commercial development. Cover stories focus on creative applications of the technology by an artist or ...


Computers, IEEE Transactions on

Design and analysis of algorithms, computer systems, and digital networks; methods for specifying, measuring, and modeling the performance of computers and computer systems; design of computer components, such as arithmetic units, data storage devices, and interface devices; design of reliable and testable digital devices and systems; computer networks and distributed computer systems; new computer organizations and architectures; applications of VLSI ...


Computing in Science & Engineering

Physics, medicine, astronomy—these and other hard sciences share a common need for efficient algorithms, system software, and computer architecture to address large computational problems. And yet, useful advances in computational techniques that could benefit many researchers are rarely shared. To meet that need, Computing in Science & Engineering (CiSE) presents scientific and computational contributions in a clear and accessible format. ...


More Periodicals

Most published Xplore authors for Documentation

Back to Top

No authors for "Documentation"


Xplore Articles related to Documentation

Back to Top

IEE Colloquium on 'Issues in Computer Support for Documentation and Manuals' (Digest No.1993/170)

IEE Colloquium on Issues in Computer Support for Documentation and Manuals, 1993

None


DynaDoc: Automated On-demand Context-Specific Documentation

2018 IEEE Third International Workshop on Dynamic Software Documentation (DySDoc3), 2018

This 2018 DOCGEN Challenge paper describes DynaDoc, an automated documentation system for on-demand context-specific documentation. A key novelty is the use of graph database technology with an eXtensible Common Software Graph Schema (XCSG). Using XCSG-based query language, DynaDoc can mine efficiently and accurately a variety of program artifacts and graph abstractions from millions of lines of code to provide semantically ...


ISO/IEC/IEEE International Standard - Systems and software engineering -- Requirements for managers of user documentation

ISO/IEC/IEEE 26511 First edition 2011-12-01; Corrected version 2012-03-15, 2012

ISO/IEC/IEEE 26511:2012 specifies procedures for managing user documentation throughout the software life cycle. It applies to people or organizations producing suites of documentation, to those undertaking a single documentation project, and to documentation produced internally, as well as to documentation contracted to outside service organizations. It provides an overview of the software documentation and information management processes, and also presents ...


Database support for the production of reusable technical documentation

IEE Colloquium on Issues in Computer Support for Documentation and Manuals, 1993

The approach to the production of technical documentation described arose from a need to supply documentation for a large library of mathematical software. There has been a growing demand to supply documentation in a variety of printed and online formats, tailored to the particular needs of end users. There is also an increasing number of new products which contain the ...


When Not to Comment: Questions and Tradeoffs with API Documentation for C++ Projects

2018 IEEE/ACM 40th International Conference on Software Engineering (ICSE), 2018

Without usable and accurate documentation of how to use an API, developers can find themselves deterred from reusing relevant code. In C++, one place developers can find documentation is in a header file. When information is missing, they may look at the corresponding implementation code. To understand what's missing from C++ API documentation and the factors influencing whether it will ...


More Xplore Articles

Educational Resources on Documentation

Back to Top

IEEE-USA E-Books

  • IEE Colloquium on 'Issues in Computer Support for Documentation and Manuals' (Digest No.1993/170)

    None

  • DynaDoc: Automated On-demand Context-Specific Documentation

    This 2018 DOCGEN Challenge paper describes DynaDoc, an automated documentation system for on-demand context-specific documentation. A key novelty is the use of graph database technology with an eXtensible Common Software Graph Schema (XCSG). Using XCSG-based query language, DynaDoc can mine efficiently and accurately a variety of program artifacts and graph abstractions from millions of lines of code to provide semantically rich documentation. DynaDoc leverages the extensibility of XCSG to link program artifacts to supplementary information such as commits and issues.

  • ISO/IEC/IEEE International Standard - Systems and software engineering -- Requirements for managers of user documentation

    ISO/IEC/IEEE 26511:2012 specifies procedures for managing user documentation throughout the software life cycle. It applies to people or organizations producing suites of documentation, to those undertaking a single documentation project, and to documentation produced internally, as well as to documentation contracted to outside service organizations. It provides an overview of the software documentation and information management processes, and also presents aspects of portfolio planning and content management that user documentation managers apply. It covers management activities in starting a project, including setting up procedures and specifications, establishing infrastructure, and building a team. It includes examples of roles needed on a user documentation team. It addresses measurements and estimates needed for management control, and the use of supporting processes such as change management, schedule and cost control, resource management, and quality management and process improvement. It includes requirements for key documents produced for user documentation management, including documentation plans and documentation management plans. ISO/IEC/IEEE 26511:2012 is independent of the software tools that may be used to produce or manage documentation, and applies to both printed documentation and on-screen documentation. Much of its guidance is applicable to user documentation for systems including hardware as well as software.

  • Database support for the production of reusable technical documentation

    The approach to the production of technical documentation described arose from a need to supply documentation for a large library of mathematical software. There has been a growing demand to supply documentation in a variety of printed and online formats, tailored to the particular needs of end users. There is also an increasing number of new products which contain the original library as an embedded sub-component. First attempts to meet the demand for diverse forms of documentation led to the creation of many different bodies of text, containing similar information, but maintained and often authored separately. The solution to this problem was to develop a database which contains all the information previously held in the library documentation. The database can be used to generate both the original documents and new documents with varying style, format or content. There were two main processes involved in the transformation of documents to database records. The first was an object-oriented decomposition of the documented product, identifying all the sub-components and the important information relating to each one. The second process was to mark up text records using the Standard Generalized Markup Language (SGML), an ISO standard (8879) for the mark up of computer-held documents.<<ETX>>

  • When Not to Comment: Questions and Tradeoffs with API Documentation for C++ Projects

    Without usable and accurate documentation of how to use an API, developers can find themselves deterred from reusing relevant code. In C++, one place developers can find documentation is in a header file. When information is missing, they may look at the corresponding implementation code. To understand what's missing from C++ API documentation and the factors influencing whether it will be fixed, we conducted a mixed-methods study involving two experience sampling surveys with hundreds of developers at the moment they visited implementation code, interviews with 18 of those developers, and interviews with 8 API maintainers. In many cases, updating documentation may provide only limited value for developers, while requiring effort maintainers don't want to invest. We identify a set of questions maintainers and tool developers should consider when improving API-level documentation.

  • ISO/IEC/IEEE International Standard for Systems and software engineering -- Content management for product life-cycle, user, and service management documentation

    This International Standard provides requirements for the management of the content used in product life cycle, software, and service management system documentation. Content management allows an organization to control the storage and retrieval of content objects, track content revisions, maintain a content audit trail, and enable a collaborative environment. Component content management supports the reuse of content objects among deliverables and supports multiple deliverable formats. Content objects that are unique and are maintained as independent database objects are efficient to review, approve, and update; may be combined to produce multiple deliverables; and are cost- effective to translate. The standard defines the characteristics of an effective and efficient process through which content is gathered, managed, and published, including the requirements of a system that is supported by an electronic database. Such a database should support documents or topics and content units that may be assembled to produce complete documents for print, electronic output, or content collections published through electronic media. This database is defined as a component content management system (CCMS), as distinct from a document management system. The objective of component content management is to create content objects once and use them through linking mechanisms in multiple output formats including but not limited to documents. Systems conforming to this standard can fulfill business needs for content development and management, especially the need for a single source of authoritative information. The standard includes business case considerations for acquisition of a content management system. This International Standard is independent of the software tools and markup languages that may be used to manage documentation content, and applies to both printed documentation and on-screen documentation.

  • On the similarities and differences between program documentation and test documentation

    Program documentation is a vital source of information for software engineers charged with making changes to complex applications. Test documentation can be used to help future stakeholders understand the rationale behind the testing effort. This panel will discuss some of the similar features and salient differences between program documentation and test documentation. Although both types of documentation are usually written by and for different groups of people (for reasonable-sized projects), there is enough overlap that each could be improved by studying the communication strategies of the other.

  • Minimalism and quick reference documentation

    Two forms of quick reference (QR) documentation discussed are syntax summaries and quick reference guides. Syntax summaries typically list tasks or commands in alphabetical order, often on a single sheet or card (for example, the action to bold text is press SHIFT+B). Quick reference guides contain more extended procedures and often come in booklets (for example, giving a four step procedure to set up columns in a document). QR documentation is usually regraded more as a reference than a learning tool more for memory jogging than for initial learning. However, the author looks at the learning function and analyses it using the minimalist model developed by J.M. Carroll (1990).<<ETX>>

  • Code Documentation

    The basic principles of good code documentation include the avoidance of repetition, the coexistence of code and its documentation, the documentation of all artifacts, and a preference for clear code and automated processes to explanatory documentation. Existing tools can help us by extracting documentation from specially formatted comments and by formatting code listed in documents. We can also automate the generation of bespoke documentation with a custom-made tool. When you document code, strive for completeness, consistency, effortless accessibility, and an automated low-overhead generation process.

  • Computer aided documentation for software maintenance

    Upon inspection much of the documentation that exists for software applications is either associated with its design or its user interface i.e. reference manuals and user guides. Little, if any documentation, is specifically produced to help those who are involved with looking after the application once it is released to its users, and enters its maintenance phase. If such documentation does exist it is often found not to accurately represent the current state of the application. As a solution, the author suggests the use of code documentation tools. These tools can provide those involved with looking after existing applications with virtual information, and the mechanism for keeping notes about them. In the same way that a carpenter or a plumber needs the right tools to complete their jobs, those working in maintaining software need tools to help them perform their tasks in an effective manner. Code documentation tools are now available which can not only aid the extraction and analysis of existing applications, but provide accurate information in a form that is easy to understand, interactive in use, and most importantly is shareable by all those needed to work on the project.<<ETX>>



Standards related to Documentation

Back to Top

IEEE Application Guide for Distributed Digital Control and Monitoring for Power Plants


IEEE Guide for Failure Investigation, Documentation, and Analysis for Power Transformers and Shunt Reactors


IEEE Standard Criteria for Digital Computers in Safety Systems of Nuclear Power Generating Stations

This standard serves to amplify criteria in IEEE Std 603-2009, IEEE Standard Criteria for Safety Systems for Nuclear Power Generating Stations, to address the use of computers as part of safety systems in nuclear power generating stations. The criteria contained herein, in conjunction with criteria in IEEE Std 603-2009, establish minimum functional and design requirements for computers used as components ...


IEEE Standard for Information Technology - POSIX Ada Language Interfaces - Part 1: Binding for System Application Program Interface (API)

This document is part of the POSIX series of standards for applications and user interfaces to open systems. It defines the Ada language bindings as package specifications and accompanying textual descriptions of the applications program interface (API). This standard supports application portability at the source code level through the binding between ISO 8652:1995 (Ada) and ISO/IEC 9945-1:1990 (IEEE Std 1003.1-1990 ...


IEEE Standard for Software User Documentation

This standard provides minimum requirements for the structure, information content, and format of user documentation, to include both paper and electronic documentation used in the work environment by users of systems containing software. The standard is limited to the software documentation product and will not include the processes of developing or managing software user documentation. The standard includes printed user ...


More Standards