Journal articles: 'Technical documentation'

1

White, Hollie C. "Documentation in Technical Services." Serials Librarian 49, no. 3 (January 5, 2006): 47–55. http://dx.doi.org/10.1300/j123v49n03_04.

Full text

APA, Harvard, Vancouver, ISO, and other styles

2

Caher, John M. "Technical Documentation and legal Liability." Journal of Technical Writing and Communication 25, no. 1 (January 1995): 5–10. http://dx.doi.org/10.2190/9xpr-qj5l-pul2-lw9j.

Full text

Abstract:

Litigation rooted in disputes over the interpretation and sufficiency of technical documentation is increasingly common as a number of suits have been filed in state and federal courts. This article describes the matter of Martin v. Hacker (83 NY2nd 1, Nov. 23, 1993), a recent case in which New York's highest court analyzed a technical writer's prose in the context of a lawsuit over a drug-induced suicide.

APA, Harvard, Vancouver, ISO, and other styles

3

Čurepić, Danko, and Zdravko Toš. "Technical Documentation in Traffic Technology." PROMET - Traffic&Transportation 21, no. 5 (March 2, 2012): 359–65. http://dx.doi.org/10.7307/ptt.v21i5.251.

Full text

Abstract:

The requirements for the prompt usage of traffic infrastructure capacities define the technological frames which ensure updated maintenance and development of new traffic infrastructure capacities by implementing graphical and computer systems. Technical documentation (TD) based on the technology of geographic information systems (GIS) allows fast analysis of graphical and alphanumerical data with the aim of identifying spatial relations among various cartographic elements. The paper analyses and presents the methodological bases of building GIS with the aim of designing the traffic network topology, as well as structural and functional analysis which uses the acquired knowledge to propose concrete solutions on connecting data about the position of infrastructure facilities with their properties in the railway traffic safety. KEY WORDS: technical documentation, geographic information system, structural and functional analysis, software for technical drawing, signalling devices, railway

APA, Harvard, Vancouver, ISO, and other styles

4

REITER, EHUD, CHRIS MELLISH, and JOHN LEVINE. "AUTOMATIC GENERATION OF TECHNICAL DOCUMENTATION." Applied Artificial Intelligence 9, no. 3 (May 1995): 259–87. http://dx.doi.org/10.1080/08839519508945476.

Full text

APA, Harvard, Vancouver, ISO, and other styles

5

Andersen, Asbjørn, and Klaus Heje Munch. "Automatic generation of technical documentation." Expert Systems with Applications 3, no. 2 (January 1991): 219–27. http://dx.doi.org/10.1016/0957-4174(91)90150-d.

Full text

APA, Harvard, Vancouver, ISO, and other styles

6

Shirk, Henrietta Nickels. "Technical Writing's Roots in Computer Science: The Evolution from Technician to Technical Writer." Journal of Technical Writing and Communication 18, no. 4 (October 1988): 305–23. http://dx.doi.org/10.2190/l65t-6lj1-pvkr-t6nl.

Full text

Abstract:

The history of Technical Writing closely parallels trends in the discipline of Computer Science. The early technical writers in the computer software industry were its own technicians (programmers and analysts), who used a variety of diagramming techniques to document computer systems. As a result of the widespread availability of computers and software which began in the 1970s, professional communicators joined the software industry and reinterpreted these diagramming techniques from technical source documents into user documentation. The impact of this assimilation process has influenced graphic representations in Technical Writing, as well as created the conceptual metaphors of the “user” and the “module” (which are emerging archetypes). In the past, Technical Writing's historical roots have been the result of reactions to Computer Science. However, the increasing presence of online documentation is now creating opportunities for technical writers to shape their own future by joining with computer scientists as influential equals.

APA, Harvard, Vancouver, ISO, and other styles

7

Tănase, Delia. "Teaching Professional and Technical Communication: The Case of Technical Documentation." Balkan Region Conference on Engineering and Business Education 2, no. 1 (December 20, 2017): 20–24. http://dx.doi.org/10.1515/cplbu-2017-0004.

Full text

Abstract:

Abstract The present article highlights important aspects that need to be considered in the design of the academic linguistic training oriented to develop students’ technical documentation-related writing skills viewed as critical career-boosting skills that influence and condition employees’ promotion and graduates’ hiring chances. Technical documentation is an umbrella term covering different types of technical documents (e.g. technical reports, manufacturing standards, installation guides, quick references cards, troubleshooting guides, release notes, etc.) which, irrespective of usage or function, observe general characteristics and share essential features whose effective recognition and knowledgeability facilitate students’ upward career trajectory. The topic is discussed from the perspective of two teaching priorities - awareness of stylistic features characteristic of technical documentation and awareness of performance standards in terms of technical documentation production - within the ESP (English for Specific Purposes) and BELF (English as Business Lingua Franca) frameworks that prioritize the performative and lingua franca dimensions of the English language use in the currently-emerging globalized workplaces.

APA, Harvard, Vancouver, ISO, and other styles

8

Dychka, Nataliia, and Nataliia Hordiienko. "STYLISTIC FEATURES OF ENGLISH TECHNICAL DOCUMENTATION." Young Scientist 1, no. 65 (January 2019): 357–60. http://dx.doi.org/10.32839/2304-5809/2019-1-65-81.

Full text

APA, Harvard, Vancouver, ISO, and other styles

9

Strassmann, Paul. "Measuring the Productivity of Technical Documentation." Journal of Information Technology 3, no. 1 (March 1988): 25–33. http://dx.doi.org/10.1177/026839628800300105.

Full text

APA, Harvard, Vancouver, ISO, and other styles

10

Strassmann, Paul. "Measuring the Productivity of Technical Documentation." Journal of Information Technology 3, no. 1 (March 1988): 25–33. http://dx.doi.org/10.1057/jit.1988.5.

Full text

APA, Harvard, Vancouver, ISO, and other styles

11

Brisson, Roger. "Online Documentation in Library Technical Services." Technical Services Quarterly 16, no. 3 (March 1999): 1–19. http://dx.doi.org/10.1300/j124v16n03_01.

Full text

APA, Harvard, Vancouver, ISO, and other styles

12

SAUER, BEVERLY A. "Sense and Sensibility in Technical Documentation." Journal of Business and Technical Communication 7, no. 1 (January 1993): 63–83. http://dx.doi.org/10.1177/1050651993007001004.

Full text

APA, Harvard, Vancouver, ISO, and other styles

13

Krtalić, Maja, and Stjepan Zlatić. "Documentation on industrial and technical heritage." Libellarium: journal for the research of writing, books, and cultural heritage institutions 1, no. 10 (December 19, 2017): 93. http://dx.doi.org/10.15291/libellarium.v1i1.300.

Full text

APA, Harvard, Vancouver, ISO, and other styles

14

Farazi, Feroz, Craig Chapman, Pathmeswaran Raju, and William Byrne. "Model-based documentation." Encyclopedia with Semantic Computing and Robotic Intelligence 01, no. 01 (March 2017): 1630009. http://dx.doi.org/10.1142/s2425038416300093.

Full text

Abstract:

Knowledge acquisition is becoming an integral part of the manufacturing industries, which rely on domain experts in various phases of product life cycle including design, analysis, manufacturing, operation and maintenance. It has the potential to enable knowledge reuse, however, poorly managed knowledge can cause information loss and inefficiency. If technical documentation is managed well in the manufacturing industries, intended piece of knowledge can easily be located, used and reused for purpose and as a result, the corresponding industry can be benefited. Some examples of technical documentation are design specification, operating manual and maintenance manual. Model-based Documentation (MBD) is a documentation approach that uses model to provide structure to the data of the documents. MBD can be thought of as a way to better organize knowledge thereby knowledge identification and retrieval become easier, faster and efficient. In this paper, we propose MBD and its extension as a potential solution to overcome the issues involved in the typical technical documentation approaches.

APA, Harvard, Vancouver, ISO, and other styles

15

Manukonda, Ramesh. "English for Scientific & Technical Writing." International Journal for Research in Applied Science and Engineering Technology 10, no. 11 (November 30, 2022): 916–19. http://dx.doi.org/10.22214/ijraset.2022.47469.

Full text

Abstract:

Abstract: ‘Communication is important not only in an organization but also in our daily life. When we use communication pertaining to technical, industrial or business matters belong to the category of technical or business communication’’. Scientific and technical writing, a form of technical communication, is a style of writing used in fields of diverse as computer hardware and software, engineering, chemistry, the aerospace, industry, robotics, finance, consumer electronics and biotechnology. Technical writing teams or departments are often referred to as Information development, User Assistance, Technical Documentation, or Technical Publications. Technical writers themselves may be called API writers, information developers, documentation specialists, documentation engineers, or technical content developers. Specific areas to be elaborated on the full paper. “ Nature of scientific and technical documentation-basics of scientific and technical documentation- organization in technical and scientific documentation – style in technical and scientific documentation –ABC of good technical and scientific documentation – history of technical and scientific documentation’. Broadly speaking, technical documentation can be categorized into three types, depending on the style of writing, the level of knowledge transferred and the target audience. End user assistance: These information products help a user understand how ton use a technical software or hardware product. Traditional technical documentation: here the objective of the writer is to communicate with a specific audience.

APA, Harvard, Vancouver, ISO, and other styles

16

Murtiyoso, A., P. Grussenmeyer, and D. Suwardhi. "TECHNICAL CONSIDERATIONS IN LOW-COST HERITAGE DOCUMENTATION." ISPRS - International Archives of the Photogrammetry, Remote Sensing and Spatial Information Sciences XLII-2/W17 (November 29, 2019): 225–32. http://dx.doi.org/10.5194/isprs-archives-xlii-2-w17-225-2019.

Full text

Abstract:

Abstract. The use of photogrammetry in 3D heritage documentation has matured over the recent years. In the same time, many types of sensors have also been developed in the field of imaging. While photogrammetry is considered as a low-cost alternative to TLS, several options exist in terms of sensor type with trade-offs between price, ease of use, and quality of resolution. Nevertheless, a proper knowledge on the acquisition and processing is still required to generate acceptable results. This paper aims to compare three photogrammetric sensors, namely a classical DSLR camera, a drone, and a spherical 360° camera in documenting heritage sites. Main comparison points include quality of the bundle adjustment and quality of the dense point cloud. However, an important point of the paper is also to determine whether a sensor at a given cost and effort is enough for documentation purposes. A TLS point cloud data was used as a common reference, as well as control and check points issued from geodetic surveying. In the aftermath of the comparison, several technical suggestions and recommendations were proposed as regards to the use of each sensor.

APA, Harvard, Vancouver, ISO, and other styles

17

Galkovskaya, Victoria. "State environmental expertise of draft technical documentation." Legal Science and Practice: Journal of Nizhny Novgorod Academy of the Ministry of Internal Affairs of Russia 2022, no. 1 (March 30, 2022): 37–43. http://dx.doi.org/10.36511/2078-5356-2022-1-37-43.

Full text

Abstract:

The period between 19th—20th centuries was rich in innovations in the field of environmental protection, including the tightening of requirements for the implementation of projects that can have a negative impact on the environment. These requirements, imposed at the legislative level and aimed at the realization of citizens’ rights to a favorable environment, reliable information about it and on compensation for damage caused to health and property by an environmental offense, according to Art. 42 of the Constitution of the Russian Federation, often have an ambiguous interpretation, which leads to the emergence of controversial situations in the implementation of the functions of control and supervisory bodies. One of these bottlenecks of Russian environmental legislation is federal law no. 174-FZ “On Environmental Expertise” of October 23, 1995 regarding the inclusion in Art. 11 objects of state environmental expertise of draft technical documentation for new equipment, technology, the use of which can have an impact on the environment. As practice shows, the norms of environmental legislation do not disclose the terms “new technology” and “new technology”, which leads to the emergence of judicial precedents in the passage of state environmental expertise related to the ambiguous interpretation of these concepts. The aim of this study is to make an attempt to assess the impact of gaps in environmental legislation on environmental law actors and suggest ways to resolve them.

APA, Harvard, Vancouver, ISO, and other styles

18

Ramírez Polo, Laura. "Controlled languages and technical documentation: Improving translatability." Tradumàtica: tecnologies de la traducció, no. 10 (February 5, 2013): 192. http://dx.doi.org/10.5565/rev/tradumatica.25.

Full text

APA, Harvard, Vancouver, ISO, and other styles

19

Goodwin, David. "Emplotting the Reader: Motivation and Technical Documentation." Journal of Technical Writing and Communication 21, no. 2 (April 1991): 99–115. http://dx.doi.org/10.2190/1tld-2jbl-dd7x-pxk3.

Full text

APA, Harvard, Vancouver, ISO, and other styles

20

Svensson Tengberg, Charlotte, and Carl-Eric Hagentoft. "Relying on reference cases when evaluating new technical solutions? Evaluation of technical documentation in a case study." E3S Web of Conferences 172 (2020): 10007. http://dx.doi.org/10.1051/e3sconf/202017210007.

Full text

Abstract:

Serial failures have occurred when introducing new technical solutions in the Swedish construction industry. In an earlier interview study exploring introduction of new technical solutions, documentation and reference cases provided by the supplier are given as the main sources for evaluation. This paper aims at addressing the questions: 1. What kind of documentation concerning building physics are provided by suppliers? 2. How well does the suppliers’ documentation meet the need for verification? In order to address these questions, the case of hygrothermal performance of cross laminated timber structures in multifamily dwellings was chosen. An inquiry of data was sent out to four suppliers at the Swedish market, asking for documentation and reference cases provided. Based on the documentation given, an assessment was made of to which extend the documentation can support verification of appliance to the relevant requirements of the Swedish building regulations. The case study shows reference cases are scarce and existing documentation is not comprehensive, thus indicating the building industry might have a disproportional high confidence in reference cases. The results will be used to suggest requirements for reference cases to be used for verification.

APA, Harvard, Vancouver, ISO, and other styles

21

Bergua Jiménez, Edorta, and Manu González Baragaña. "Zikloteka, centro de documentación de la bicicleta. Una iniciativa avan-zada de recopilación, tratamiento y difusión de documentación sobre la movilidad ciclista." Hábitat y Sociedad, no. 13 (November 4, 2020): 265—xxx. http://dx.doi.org/10.12795/habitatysociedad.2020.i13.15.

Full text

Abstract:

During the last two decades, a significant volume of materials related to everyday cycling have been produced in Gipuzkoa. This documentation, scattered in many locations until now, represents a considerable heritage of administrative, scientific, technical and citizens’ knowledge produced in this area, as well as underlining the effort undertaken to normalize the use of the bicycle as a means of transport in this territory. The Gipuzkoa Provincial Council and the Cristina Enea Foundation set up the Zikloteka in 2015, a specialized documentation centre in cycle mobility in Gipuzkoa, in order to identify, compile, preserve and disseminate this heritage, which currently contains over 3,800 references. The article presents the main characteristics, services, management system and takes stock of its trajectory. The glossary drawn up to classify the materials is its main contribution in the technical documentation area specialized in mobility. It underlines the collaboration with different entities, such as the Red de Ciudades por la Bicicleta (Cities for Cycling Network), ConBici, and the Network of Environmental Information and Documentation Centres which, complemented by a lengthy search, collection and management process, make it a unique specialized documentation centre in cycle mobility in Europe.

APA, Harvard, Vancouver, ISO, and other styles

22

Dhizhnevskaya, O., F. Genova, B. Hauck, P. Boyce, M. Beaseli, H. Dickel, A. Hearn, et al. "Commission 5: Documentation and Astronomical Data: (Documentation et Donnees Astronomiques)." Transactions of the International Astronomical Union 24, no. 1 (2000): 369–77. http://dx.doi.org/10.1017/s0251107x00003321.

Full text

Abstract:

Four working groups and three task groups of IAU Commission 5 deal specifically with information handling, technical aspects of collection, archiving, storage and dissemination of data, with designations and classification of astronomical objects, with library services, editorial policies, computer communications, ad hoc methodologies, and with various standards, reference frames etc. Information about Commission 5 working and task groups and their activities may be found in http://nut.inasan.rssi.ru/IAU/.

APA, Harvard, Vancouver, ISO, and other styles

23

Markovets, O. V., and A. I. Synko. "Formation of High-Quality Technical Documentation for Software." Visnyk of Vinnytsia Politechnical Institute 155, no. 2 (2021): 98–106. http://dx.doi.org/10.31649/1997-9266-2021-155-2-98-106.

Full text

APA, Harvard, Vancouver, ISO, and other styles

24

Koo, Heung-Seo. "Adopting DITA Standard for Developing Technical Documentation Efficiently." Transactions of The Korean Institute of Electrical Engineers 65, no. 1 (January 1, 2016): 171–78. http://dx.doi.org/10.5370/kiee.2016.65.1.171.

Full text

APA, Harvard, Vancouver, ISO, and other styles

25

Barstow, Thomas R., and Joseph T. Jaynes. "Integrating online documentation into the technical publishing process." IEEE Transactions on Professional Communication PC-29, no. 4 (1986): 37–41. http://dx.doi.org/10.1109/tpc.1986.6448987.

Full text

APA, Harvard, Vancouver, ISO, and other styles

26

Davidson, N., G. Nanava, T. Przedziński, E. Richter-Wa̧s, and Z. Wa̧s. "Universal interface of TAUOLA: Technical and physics documentation." Computer Physics Communications 183, no. 3 (March 2012): 821–43. http://dx.doi.org/10.1016/j.cpc.2011.12.009.

Full text

APA, Harvard, Vancouver, ISO, and other styles

27

Sherry, Marion M. "Methodology for Software Documentation Reuse." Proceedings of the Human Factors Society Annual Meeting 36, no. 3 (October 1992): 198–201. http://dx.doi.org/10.1518/107118192786751772.

Full text

Abstract:

This paper describes a documentation writing methodology developed and used by the author to address some of the issues of consistency in documentation and product function, redundancy of research and solution, and product usability (including timeliness of delivery and quality of support) for a software product engineered, developed and deployed in a multi-organizational or corporate environment. The methodology is compatible with technical systems engineering, development and testing documentation requirements, and is applicable to software products for which there are existing or anticipated “user guides”. The method used to accomplish these goals is the incorporation of existing user guide formats, wherever possible, in the documentation of technical specifications for detailed engineering, development and testing requirements. This paper describes the “cycle of documentation” methodology employed, identifies opportunities to use this methodology, and describes some of the benefits derived from using the methodology (both initially intended and later discovered).

APA, Harvard, Vancouver, ISO, and other styles

28

Vasilenko, Mikhail, Petr Bulavskiy, and Petr Vasilenko. "Analysis and classification of cyberatacks on online technical documentation of railroad automation and telemechanics." Proceedings of Petersburg Transport University, no. 3 (September 20, 2018): 358–65. http://dx.doi.org/10.20295/1815-588x-2018-3-358-365.

Full text

Abstract:

Objective: To analyze modifications of cyberattacks on online technical documentation of railroad security systems. Methods: The specificity of railroad automation and telemechanics (RAT) documentation maintenance in electronic document management systems was estimated and presented. Also the assessment of enforceability of cyberattacks under actual operating conditions was given. Results: The possibility of critical failure of train control systems resulting from cyber faults of error type in technical documentation was demonstrated. A classification of cyberattacks on electronic databases of technical documentation was introduced. Vulnerability of the latter was uncovered. Practical importance: The necessity to develop special security measures for electronic databases of RAT technical documentation was justified. It concerned cyber faults of error type. Moreover, practical implementation alternatives of security methods in case of cyberattacks were introduced.

APA, Harvard, Vancouver, ISO, and other styles

29

SHIMADA, Hiromi. "Standardization Activity of Digital Technical Product Documentation in JAMA." Journal of the Japan Society for Precision Engineering 83, no. 8 (2017): 727–31. http://dx.doi.org/10.2493/jjspe.83.727.

Full text

APA, Harvard, Vancouver, ISO, and other styles

30

Waddell, Craig, and Beverly Sauer. "The Rhetoric of Risk: Technical Documentation in Hazardous Environments." College Composition and Communication 55, no. 4 (June 2004): 766. http://dx.doi.org/10.2307/4140671.

Full text

APA, Harvard, Vancouver, ISO, and other styles

31

Sirenko, К. A. "Improvement of Regulatory and Technical Documentation for Foundry Fabrics." Casting Processes 145, no. 3 (September 1, 2021): 69–76. http://dx.doi.org/10.15407/plit2021.03.069.

Full text

APA, Harvard, Vancouver, ISO, and other styles

32

Лепаров and M. Leparov. "Engineering Analysis of the Design Documentation of Technical Object." Geometry & Graphics 3, no. 4 (December 17, 2015): 38–44. http://dx.doi.org/10.12737/17349.

Full text

Abstract:

An engineering analysis of the technical documentation means the activity by which the information is set in the documentation is extracted to verify the correctness of a given point of view of implementation, further development of the documentation (technical object) or accumulation of engineering experience. The current paper provides a summary of the types of engineering analysis, which can be carried out based on the design documentation. The following types of analysis are discussed in the paper: structural (the definition of the components of the object and connections between them); constructive (realization of major constructive activities); conceptual (search for other conceptual versions of the product); functional (determination of the object functions); geometrical (determination of other variants of the components shape, their placement and the connections between them); for calculation (determination of the necessary calculations); research (identification of the necessary tests); of safety (analysis of the product from the point of view of human safety); functional value (technical and economic improvement); dimensional (determination of fits and deviations of dimensions); technological control (inspection of the parts from the viewpoint of manufacturability); metrological (the same, but from the viewpoint of measurement); heuristic (search of ideas for improving of the object); of modification (search for modifications of the object); for regulatory control (check for complying with all regulatory requirements); ergonomic (analysis of the product from an ergonomic point of view); aesthetic (arrangement of aesthetic point of view); of transport (analysis of the object from the point of view of its transport); technological (analysis of the product from the point of view of its manufacture); operational (analysis of the product from the point of view of its operation); of repair (analysis of the product from the point of view of its repair); of utilization (analysis from the viewpoint of utilization); environmental (analysis from the viewpoint of environmental pollution); correctional (correction of the documentation). These analyzes can be used in the engineering training of students — a part of them in the course "Technical Documentation" or disciplines with similar names, while the other parts in the other design disciplines.

APA, Harvard, Vancouver, ISO, and other styles

33

Baratov, D., N. Aripov, O. Muxiddinov, and X. Jumanov. "Block diagram of the automatic model of technical documentation." Journal of Physics: Conference Series 1614 (August 2020): 012032. http://dx.doi.org/10.1088/1742-6596/1614/1/012032.

Full text

APA, Harvard, Vancouver, ISO, and other styles

34

Oevermann, Jan. "Semantic PDF Segmentation for Legacy Documents in Technical Documentation." Procedia Computer Science 137 (2018): 55–65. http://dx.doi.org/10.1016/j.procs.2018.09.006.

Full text

APA, Harvard, Vancouver, ISO, and other styles

35

Bauer, C. O. "The important role of technical documentation in product liability." International Journal of Pressure Vessels and Piping 61, no. 2-3 (January 1995): 213–28. http://dx.doi.org/10.1016/0308-0161(94)00108-u.

Full text

APA, Harvard, Vancouver, ISO, and other styles

36

Barone, S., P. Neri, A. Paoli, and A. V. Razionale. "Automatic technical documentation of lithic artefacts by digital techniques." Digital Applications in Archaeology and Cultural Heritage 11 (December 2018): e00087. http://dx.doi.org/10.1016/j.daach.2018.e00087.

Full text

APA, Harvard, Vancouver, ISO, and other styles

37

Baratov, D., N. Aripov, O. Muxiddinov, and X. Jumanov. "Block diagram of the automatic model of technical documentation." IOP Conference Series: Materials Science and Engineering 918 (October 7, 2020): 012084. http://dx.doi.org/10.1088/1757-899x/918/1/012084.

Full text

APA, Harvard, Vancouver, ISO, and other styles

38

Compton, Joan Callahan. "Results of a telephone survey of technical documentation users." IEEE Transactions on Professional Communication PC-29, no. 4 (1986): 93–100. http://dx.doi.org/10.1109/tpc.1986.6448997.

Full text

APA, Harvard, Vancouver, ISO, and other styles

39

Lozano-Nieto, A. "The Art Of Technical Documentation, 2nd Ed. [Book Review]." IEEE Transactions on Professional Communication 41, no. 4 (December 1998): 289–90. http://dx.doi.org/10.1109/tpc.1998.735375.

Full text

APA, Harvard, Vancouver, ISO, and other styles

40

Floyd, R. E. "The Rhetoric of Risk—Technical Documentation in Hazardous Environments." IEEE Transactions on Professional Communication 47, no. 3 (September 2004): 222–23. http://dx.doi.org/10.1109/tpc.2004.833698.

Full text

APA, Harvard, Vancouver, ISO, and other styles

41

Lanzer, Peter, Frank J. H. Gijsen, L. D. Timmie Topoleski, and Gerhard A. Holzapfel. "Call for Standards in Technical Documentation of Intracoronary Stents." Herz 35, no. 1 (January 2010): 27–33. http://dx.doi.org/10.1007/s00059-010-3278-6.

Full text

APA, Harvard, Vancouver, ISO, and other styles

42

Uddin, Gias, Foutse Khomh, and Chanchal K. Roy. "Automatic API Usage Scenario Documentation from Technical Q&A Sites." ACM Transactions on Software Engineering and Methodology 30, no. 3 (May 2021): 1–45. http://dx.doi.org/10.1145/3439769.

Full text

Abstract:

The online technical Q&A site Stack Overflow (SO) is popular among developers to support their coding and diverse development needs. To address shortcomings in API official documentation resources, several research works have thus focused on augmenting official API documentation with insights (e.g., code examples) from SO. The techniques propose to add code examples/insights about APIs into its official documentation. Recently, surveys of software developers find that developers in SO consider the combination of code examples and reviews about APIs as a form of API documentation, and that they consider such a combination to be more useful than official API documentation when the official resources can be incomplete, ambiguous, incorrect, and outdated. Reviews are opinionated sentences with positive/negative sentiments. However, we are aware of no previous research that attempts to automatically produce API documentation from SO by considering both API code examples and reviews. In this article, we present two novel algorithms that can be used to automatically produce API documentation from SO by combining code examples and reviews towards those examples. The first algorithm is called statistical documentation, which shows the distribution of positivity and negativity around the code examples of an API using different metrics (e.g., star ratings). The second algorithm is called concept-based documentation, which clusters similar and conceptually relevant usage scenarios. An API usage scenario contains a code example, a textual description of the underlying task addressed by the code example, and the reviews (i.e., opinions with positive and negative sentiments) from other developers towards the code example. We deployed the algorithms in Opiner, a web-based platform to aggregate information about APIs from online forums. We evaluated the algorithms by mining all Java JSON-based posts in SO and by conducting three user studies based on produced documentation from the posts. The first study is a survey, where we asked the participants to compare our proposed algorithms against a Javadoc-syle documentation format (called as Type-based documentation in Opiner). The participants were asked to compare along four development scenarios (e.g., selection, documentation). The participants preferred our proposed two algorithms over type-based documentation. In our second user study, we asked the participants to complete four coding tasks using Opiner and the API official and informal documentation resources. The participants were more effective and accurate while using Opiner. In a subsequent survey, more than 80% of participants asked the Opiner documentation platform to be integrated into the formal API documentation to complement and improve the API official documentation.

APA, Harvard, Vancouver, ISO, and other styles

43

Aganina, S. A., L. S. Churina, A. I. Rupasov, and E. L. Korshunov. "Central State Archive of Scientific and Technical Documentation of St. Petersburg, One of the Largest Specialized Centers for Storage and Usage of Documents on National History of Science and Technology: 1972–2022." Herald of an archivist, no. 3 (2022): 741–55. http://dx.doi.org/10.28995/2073-0101-2022-3-741-755.

Full text

Abstract:

The article deals with preservation of documentary sources on history of technology, research, and development of technical projects, thus addressing copyright compliance and thereto pertaining wide availability of scientific achievement and also identifying such materials. The process of creating repositories of such materials in the USSR and their functioning in the Russian Federation has been long. As Leningrad/St Petersburg with its hundreds of research institutes, design bureaus, etc. was one of the centers of science, technology, and engineering (and remains so), the archive’s creation was preceded by a lengthy process of the so called “passportization,” that is, data sheet production for scientific and technical documentation, deposited in the course of city organizations’ work. To accelerate this process, in 1967, a special group was created for scientific and technical documentation under the Archival Department of the Executive Committee of the Leningrad City Council. The “passportization” identified over 300 development organizations, storing about 27 million items of scientific and technical documentation. In 1967 proposal about creation of the State Archive of Scientific and Technical Documentation in Leningrad was made to the Executive Committee of the Leningrad City Council and the Chief Archival Directorate under the Council of Ministers of the USSR, but nearly five years had passed before the Leningrad State Archive of Scientific and Technical Documentation was created by order of the Leningrad City Executive Committee no. 75-r of January 19, 1972 to preserve the most valuable scientific and technical documentation of Leningrad project and design organizations and research institutes. During the 1970s, a real team of like-minded archivists was put together and the Archive’s structure was formed, remaining to this day with some minor modifications. The archive staff gained experience of processing scientific and technical documentation and its accounting during internships in departmental technical archives; supervised by chief engineers, chief designers, architects, and leading specialists of developer organizations, they studied the organizations’ structure and main activities: projects, project composition, scientific reports, theses, design and marking of technical documentation, accounting system, etc. At present, the archive holds 463,871 items in 480 fonds of organizations, fonds of personal provenance, and other archival collections.

APA, Harvard, Vancouver, ISO, and other styles

44

Sapienza, Filipp. "Does Being Technical Matter? Xml, Single Source, and Technical Communication." Journal of Technical Writing and Communication 32, no. 2 (April 2002): 155–70. http://dx.doi.org/10.2190/pck7-mx24-x113-v9dc.

Full text

Abstract:

XML is a recent Web design language that will enable technical communicators to produce documentation that can reuse information and present it across multiple types of media for diverse audiences. However, little is understood about how XML will impact technical communication in terms of theory, academic research, and pedagogy. In this article, I argue that XML requires more interdisciplinary approaches toward the teaching and research of technical communication, particularly with respect to the integration of technical and rhetorical knowledge.

APA, Harvard, Vancouver, ISO, and other styles

45

Martishkin, V. V. "Quality management of technical products at the stage of technical projec." Izvestiya MGTU MAMI 7, no. 2-2 (March 20, 2013): 348–53. http://dx.doi.org/10.17816/2074-0530-68393.

Full text

Abstract:

The methods of quality control products at the stage of technical project. At the stage of the technical design of primary importance in improving the quality indicators are standardization and unification. As a result, the preliminary assessment of the likely quality of the products and make appropriate adjustments to the documentation, significantly reduced labor intensity and cost of obtaining the quality of products during their production.

APA, Harvard, Vancouver, ISO, and other styles

46

Navidi, Fatemeh, Mohammad Hassanzadeh, and Ali Zolghadr Shojai. "Organizational knowledge documentation in project-based institutes." Electronic Library 35, no. 5 (October 2, 2017): 994–1012. http://dx.doi.org/10.1108/el-10-2015-0196.

Full text

Abstract:

Purpose Employees, as the most important assets of an organization, acquire a great deal of experience, skills and knowledge throughout the time period they work for the organization. If their skills and technical knowledge are not documented properly, these will be lost once the employees leave the organization. Therefore, documentation is necessary for preserving this invaluable knowledge, avoiding duplication and preventing repeated mistakes that occurred in the past and, providing the junior staff with experiences gained by their predecessors. Thus, this research aims to elaborate on the role of organizational knowledge management (KM) as an essential tool for turning tacit knowledge into explicit knowledge and sharing the gained experiences with others. Design/methodology/approach This research is developmental applied research with qualitative approach and it was conducted using thematic analysis method. This method includes a semi-structured interview with 18 researchers conducting research projects at the Satellite Research Institute under the supervision of the Iran Space Agency. Findings The projects contain knowledge that is a combination of “know why”, “know what”, “know who” and “know how”. A large amount of this knowledge is, indeed, the tacit knowledge. Most of this tacit knowledge is not reflected in the project documents. Generally, the documents contain results only and they do not include experience, technical details, methodology, analysis and mistakes that were made during research activities. Documentation challenges fall into three major types: technical, human resources and administrative. Originality value Considering the necessity of documentation within the knowledge transfer process and its important role in KM; and, with respect to the lack of technical knowledge and experience transfer observed in the documents of Satellite Research Institute, this research proposes some steps that need to be taken to turn the knowledge sharing into an organizational culture.

APA, Harvard, Vancouver, ISO, and other styles

47

Pavlovic-Breneselovic, Dragana, Zivka Krnjaja, and Natasa Matovic. "Pedagogical documentation: Preschool teachers’ perspective." Zbornik Instituta za pedagoska istrazivanja 44, no. 2 (2012): 349–67. http://dx.doi.org/10.2298/zipi1202349p.

Full text

Abstract:

Educational policy shapes the positions of all stakeholders and their mutual relations in the system of preschool education through its attitude towards documentation. The attitude towards the function of pedagogical documentation in preschool education programmes reflects certain views on children, learning and nature of the programmes. Although contemporary approaches to preschool education emphasise the issue of documentation, this problem is dealt with partially and technically in our country. The aim of our research was to explore preschool teachers? perspective on documentation by investigating the current situation and teachers? preferences related to documentation type, as well as to study the purpose, meaning and process of documentation. The research was conducted on the sample of 300 preschool teachers. The descriptive method, interviewing and scaling techniques were used. Research data suggest that the field of documentation is marked by contradictions in perceiving the meaning and function of documentation, as well as by discrepancy and lack of integration at the level of conceptions, practice and educational policy. Changing the current situation in the field of documentation is not a technical matter of elaboration of certain types and forms of documentation; it demands explication of the purpose and function of documentation in keeping with the conception of preschool education programmes and a systemic approach to changes originating from the given conception.

APA, Harvard, Vancouver, ISO, and other styles

48

Krzysiak, Zbigniew, Grzegorz Bartnik, Anna Pecyna, and Waldemar Samociuk. "Technical documentation management with the use of the Access program." Mechanik 91, no. 7 (July 9, 2018): 552–54. http://dx.doi.org/10.17814/mechanik.2018.7.81.

Full text

Abstract:

The paper presents the concept of using the capabilities of Microsoft Access to manage and archive technical documentation made in the CAD systems (e.g. AutoCAD). An original application was created in the Access program for the design documentation of a rotary cleaning device prototype. It has been shown that such an application can be used to organize and view drawings without the need to use expensive commercial programs to manage drawing files.

APA, Harvard, Vancouver, ISO, and other styles

49

Giretzlehner, Michael, Isabell Ganitzer, and Herbert Haller. "Technical and Medical Aspects of Burn Size Assessment and Documentation." Medicina 57, no. 3 (March 5, 2021): 242. http://dx.doi.org/10.3390/medicina57030242.

Full text

Abstract:

In burn medicine, the percentage of the burned body surface area (TBSA-B) to the total body surface area (TBSA) is a crucial parameter to ensure adequate treatment and therapy. Inaccurate estimations of the burn extent can lead to wrong medical decisions resulting in considerable consequences for patients. These include, for instance, over-resuscitation, complications due to fluid aggregation from burn edema, or non-optimal distribution of patients. Due to the frequent inaccurate TBSA-B estimation in practice, objective methods allowing for precise assessments are required. Over time, various methods have been established whose development has been influenced by contemporary technical standards. This article provides an overview of the history of burn size estimation and describes existing methods with a critical view of their benefits and limitations. Traditional methods that are still of great practical relevance were developed from the middle of the 20th century. These include the “Lund Browder Chart”, the “Rule of Nines”, and the “Rule of Palms”. These methods have in common that they assume specific values for different body parts’ surface as a proportion of the TBSA. Due to the missing consideration of differences regarding sex, age, weight, height, and body shape, these methods have practical limitations. Due to intensive medical research, it has been possible to develop three-dimensional computer-based systems that consider patients’ body characteristics and allow a very realistic burn size assessment. To ensure high-quality burn treatment, comprehensive documentation of the treatment process, and wound healing is essential. Although traditional paper-based documentation is still used in practice, it no longer meets modern requirements. Instead, adequate documentation is ensured by electronic documentation systems. An illustrative software already being used worldwide is “BurnCase 3D”. It allows for an accurate burn size assessment and a complete medical documentation.

APA, Harvard, Vancouver, ISO, and other styles

50

Sedykh, Dmitriy Vladimirovich. "Integration solutions based on the industrial format of technical documentation." Transport of the Urals, no. 4 (2016): 52–57. http://dx.doi.org/10.20291/1815-9400-2016-4-52-57.

Full text

APA, Harvard, Vancouver, ISO, and other styles

Journal articles on the topic 'Technical documentation'

Create a spot-on reference in APA, MLA, Chicago, Harvard, and other styles