Please wait, while we are loading the content...
Please wait, while we are loading the content...
| Content Provider | ACM Digital Library |
|---|---|
| Author | Murphy, Steve MacKinnon, Neil |
| Abstract | This paper presents a framework for improving the presentation of Unified Modeling Language (UML) diagrams, as applied in technical documentation produced at the IBM Toronto Software Laboratory. UML diagrams are a key part of program design. They can enhance understanding of complex programming concepts, and assist in problem analysis and solution design. In turn, UML diagrams can add significant value to documentation, helping the user to understand not only the solution but also the reasons for using that particular solution. Too often, however, UML diagrams are created in isolation by a developer, with little or no thought as to how they will be presented in documentation, be it online, in a PDF file, or in a printed book. This compartmentalization does not allow for the possibility that a diagram that was useful in the design phase of a project will not necessarily bring value to documentation if its stated processes or goals are unclear. Poorly designed UML diagrams can also have a negative impact on both project scheduling and costs. For example, production delays can arise because of increased back-and-forth time among developers, writers, and designers, and translation costs can escalate if a diagram contains text that must be translated.This paper presents a method for ensuring a collaborative process for UML diagram design. It provides specific tasks for each of the three key roles in developing UML diagrams for documentation: program developer, technical writer, and graphic designer. It makes the program developer aware of design principles that might otherwise be overlooked. It shows the technical writer ways to improve the design of the diagram, and offers a method for converting files to a common format that can then be utilized by the graphic designer. Finally, it provides the graphic designer with a methodology for quickly producing a clear, error-free final image that is manageable in size. By following the guidelines presented here, developers, writers, and designers can work together to produce clean, concise UML diagrams that will bring value and clarity to technical information. This clearly defined process will help eliminate miscommunication, shorten development schedules, and reduce production and translation costs. |
| Starting Page | 105 |
| Ending Page | 112 |
| Page Count | 8 |
| File Format | |
| ISBN | 158113696X |
| DOI | 10.1145/944868.944891 |
| Language | English |
| Publisher | Association for Computing Machinery (ACM) |
| Publisher Date | 2003-10-12 |
| Publisher Place | New York |
| Access Restriction | Subscribed |
| Subject Keyword | Graphic design Visualization Unified modeling language Documentation Human factors Uml diagrams Guidelines |
| Content Type | Text |
| Resource Type | Article |
National Digital Library of India (NDLI) is a virtual repository of learning resources which is not just a repository with search/browse facilities but provides a host of services for the learner community. It is sponsored and mentored by Ministry of Education, Government of India, through its National Mission on Education through Information and Communication Technology (NMEICT). Filtered and federated searching is employed to facilitate focused searching so that learners can find the right resource with least effort and in minimum time. NDLI provides user group-specific services such as Examination Preparatory for School and College students and job aspirants. Services for Researchers and general learners are also provided. NDLI is designed to hold content of any language and provides interface support for 10 most widely used Indian languages. It is built to provide support for all academic levels including researchers and life-long learners, all disciplines, all popular forms of access devices and differently-abled learners. It is designed to enable people to learn and prepare from best practices from all over the world and to facilitate researchers to perform inter-linked exploration from multiple sources. It is developed, operated and maintained from Indian Institute of Technology Kharagpur.
Learn more about this project from here.
NDLI is a conglomeration of freely available or institutionally contributed or donated or publisher managed contents. Almost all these contents are hosted and accessed from respective sources. The responsibility for authenticity, relevance, completeness, accuracy, reliability and suitability of these contents rests with the respective organization and NDLI has no responsibility or liability for these. Every effort is made to keep the NDLI portal up and running smoothly unless there are some unavoidable technical issues.
Ministry of Education, through its National Mission on Education through Information and Communication Technology (NMEICT), has sponsored and funded the National Digital Library of India (NDLI) project.
| Sl. | Authority | Responsibilities | Communication Details |
|---|---|---|---|
| 1 | Ministry of Education (GoI), Department of Higher Education |
Sanctioning Authority | https://www.education.gov.in/ict-initiatives |
| 2 | Indian Institute of Technology Kharagpur | Host Institute of the Project: The host institute of the project is responsible for providing infrastructure support and hosting the project | https://www.iitkgp.ac.in |
| 3 | National Digital Library of India Office, Indian Institute of Technology Kharagpur | The administrative and infrastructural headquarters of the project | Dr. B. Sutradhar bsutra@ndl.gov.in |
| 4 | Project PI / Joint PI | Principal Investigator and Joint Principal Investigators of the project |
Dr. B. Sutradhar bsutra@ndl.gov.in Prof. Saswat Chakrabarti will be added soon |
| 5 | Website/Portal (Helpdesk) | Queries regarding NDLI and its services | support@ndl.gov.in |
| 6 | Contents and Copyright Issues | Queries related to content curation and copyright issues | content@ndl.gov.in |
| 7 | National Digital Library of India Club (NDLI Club) | Queries related to NDLI Club formation, support, user awareness program, seminar/symposium, collaboration, social media, promotion, and outreach | clubsupport@ndl.gov.in |
| 8 | Digital Preservation Centre (DPC) | Assistance with digitizing and archiving copyright-free printed books | dpc@ndl.gov.in |
| 9 | IDR Setup or Support | Queries related to establishment and support of Institutional Digital Repository (IDR) and IDR workshops | idr@ndl.gov.in |
|
Loading...
|