The author documents the lessons he learned while working as an intern at a growing telecommunications company. Though his conclusions are not surprising, they can serve as reminders of how common certain problems are...
详细信息
The author documents the lessons he learned while working as an intern at a growing telecommunications company. Though his conclusions are not surprising, they can serve as reminders of how common certain problems are in the software industry and how important basic practices can be.
This paper discusses fundamental requirements necessary for implementing a model-based document production and management system for Construction. This system intends to capture, in concert with the contemporaneous do...
详细信息
This paper discusses fundamental requirements necessary for implementing a model-based document production and management system for Construction. This system intends to capture, in concert with the contemporaneous documents, other information about context, rationale and process. This is a requisite for formulating a project's history, and reconstructs the true accounts of what happened during a period of construction. Accurate accounts of project events are essential for a successful and equitable claim resolution.
As documentation is more and more built directly into the interface, and as technical communicators move into areas of interface design and usability if is important to have a theoretical framework within which to mak...
详细信息
ISBN:
(纸本)0914548956
As documentation is more and more built directly into the interface, and as technical communicators move into areas of interface design and usability if is important to have a theoretical framework within which to make decisions about what kind of information should be conveyed at any moment.
In preparation for the next release of its flagship software product, the International Publications Department at Waters Corporation assessed the usefulness of its current product software documentation to enable it ...
详细信息
In preparation for the next release of its flagship software product, the International Publications Department at Waters Corporation assessed the usefulness of its current product software documentation to enable it to move the next generation of documentation in the direction requested by customers. Based on extensive customer contact, a plan to dramatically revamp the documentation was formulated. Plan development involved: acquisition of customer feedback on the company's current software documentation;categorization of electronic and hardcopy documentation issues;formulation of a series of conclusions on how to proceed;evaluation of available electronic tools;acquisition of corporate sign-off of the plan;and plan execution.
We propose a set of criteria for facilitating the rigorous understanding of code components via documentation and evaluate existing notations and approaches with respect to these criteria. We present an overview of an...
详细信息
We propose a set of criteria for facilitating the rigorous understanding of code components via documentation and evaluate existing notations and approaches with respect to these criteria. We present an overview of an analysis approach designed to generate program documentation that satisfies these criteria. Because of the inherent difficulty and importance of reasoning about loops, we focus on understanding and documenting loops. We decompose loops into their component parts and obtain formal specifications of the resulting loop fragments by use of a knowledge base. We build this knowledge base for a specific application domain by designing plans that allow us to recognize stereotyped code patterns and associate them with their formal specifications. Finally, we synthesize a consistent and accurate specification of the whole loop construct from the specifications of its fragments. To evaluate our loop analysis approach, a case study was performed on a preexisting program of reasonable size. Results concerning the analyzed loops and the plans designed for them are given. To generate formal documentation of complete program modules, we briefly describe how to integrate our loop analysis approach with an existing program analysis tool, FSQ(2), which uses user-supplied loop specifications.
This paper presents an algebraic approach to the generation of tools that produce typographically effective presentations of computer programs. A specification of a formatter is generated from the context-free grammar...
详细信息
This paper presents an algebraic approach to the generation of tools that produce typographically effective presentations of computer programs. A specification of a formatter is generated from the context-free grammar of a (programming) language. These generated formatters translate abstract syntax trees of programs into box expressions. Box expressions are translated by language-independent interpreters of the box language into ASCII or TEX. The formatting rules that are generated can easily be tuned in order to get the desired formatting of programs. This is demonstrated by means of real-life applications. Furthermore, a practical solution given for the problem of formatting comments, which occur in the original text.
A documentation approach has been developed to accelerate the productivity of maintenance programmers (mps). The documentation approach takes into account that the mp's level of understanding changes as more exper...
详细信息
A documentation approach has been developed to accelerate the productivity of maintenance programmers (mps). The documentation approach takes into account that the mp's level of understanding changes as more experience is gained. Four learning stages have been identified: newcomer, student, intern and expert. Both the type of information and the form in which it is presented differs, depending upon the mp's learning stage. Mps in the four stages receive respectively contextual overviews, design stories, task-oriented manuals and reference materials. This documentation approach has been used at U.S. Army TARDEC to develop a documentation suite for a software module serving as the core of ground vehicle simulation software for the Vetronics Simulation Facility. We describe the documentation suite and what we have learned over the past two years developing and using it.
Generating simulation models is a knowledge intensive, time consuming, and error-prone task in implementing a simulator. The main purpose of this research was to find an easy, fast, and reliable way to generate simula...
详细信息
ISBN:
(纸本)9780780333833
Generating simulation models is a knowledge intensive, time consuming, and error-prone task in implementing a simulator. The main purpose of this research was to find an easy, fast, and reliable way to generate simulation models and model library. To solve this problem, the Automatic Element Routine Generation System (AERO) is developed as an efficient way for automatic model development using domain specific automatic programming techniques. Behavioral and structural models are generated from Boolean equations, truth tables, HDL descriptions, schematic diagrams, or incomplete specifications. Results show that the system could greatly reduce the cost of simulation model generation for CAD systems and, consequently, reduce the design cycle considerably.
A temporal event analysis approach to program understanding is described. program understanding is viewed as a sequence of episodes in which the programmer concludes that an informal event occurs that corresponds to s...
详细信息
ISBN:
(纸本)081867119X
A temporal event analysis approach to program understanding is described. program understanding is viewed as a sequence of episodes in which the programmer concludes that an informal event occurs that corresponds to some part of the code. This can be viewed as accepting that the code is an adequate definition of the meaning of the informal event. Often, such a definition is contingent upon working hypotheses that describe other informal program properties that should be verified in order to confirm the validity of the understanding process. Verification of working hypotheses may depend on the formulation of additional definitions or working hypotheses. The understanding process can be assisted through the use of a documentation language for describing events and hypotheses, and an hypothesis verification tool. This paper describes a temporal event language in which hypotheses are formulated in terms of expected event sequences. An hypothesis verification tool was built, and experimentation was carried out on a set of programs. The toot was found to be very useful in understanding the detailed, control oriented aspects of a program. program faults were discovered in every program that was analyzed, indicating that it facilitates a deep level of understanding.
CHI '95 will provide a forum to discuss human factors in computer documentation. Attendees will be given a specific opportunity to discuss recent developments in documentation usability. Topics include addressing ...
详细信息
ISBN:
(纸本)9780897917551
CHI '95 will provide a forum to discuss human factors in computer documentation. Attendees will be given a specific opportunity to discuss recent developments in documentation usability. Topics include addressing documentation usability early in the product design process;qualitative and quantitative methods for collecting documentation usability data;roles and relationships among documentation specialists, user-interface designers, and software developers;and schedule and budget issues relating to documentation usability.
暂无评论