现场软件是设计模式实例的实时软件文档
Filipe Lemos1, Filipe F Correia1,2, Ademar Aguiar1,2
1Faculty of Engineering, University of Porto, Porto, Portugal.
PeerJ. Computer science
|September 24, 2024
概括
本研究引入了软件模式文档的新方法,提高了代码的可理解性和开发人员的效率. 该方法通过将文档集成到IDE中来增加"活力",减少了解和发展软件系统所花费的时间.
科学领域:
- 软件工程 软件工程 软件工程
- 人与计算机的交互
- 软件 文档 软件 文档
背景情况:
- 现有的软件模式文档化方法缺乏代码和文档之间的接近.
- 当前的方法通常无法在代码更改时更新文档,导致"活力"较低.
- 这些局限性阻碍了高效的软件理解和维护.
研究的目的:
- 通过加强设计模式的文档,提出一种提高软件系统可理解性的方法.
- 通过在开发过程中增加反 (活力) 来简化软件创建和文档.
- 在统一的环境中保持代码和文档之间的近距离.
主要方法:
- 开发了一个原型工具,DesignPatternDoc,用于IntelliJ IDEA.
- 该工具不断识别代码中的模式实例,并向开发人员建议使用它们.
- 生成模式实例文档,具有实时编辑和可视化功能.
主要成果:
- 在一项对21名初学者开发人员进行的受控实验中,评估了这种方法.
- 参与者执行了涉及理解和发展小型软件系统的任务.
- 与低活力工具相比,这种方法显著减少了用于理解和记录软件的时间.
结论:
- 拟议的方法提高了软件的可理解性和开发人员的效率.
- 将文档集成到IDE中,并保持接近源代码,大大减少了上下文切换.
- 在软件模式文档中增加"活力"对于开发人员的生产力至关重要.
更多相关视频
相关概念视频
Design Example
320
The innovation of touch-tone telephony revolutionized the telecommunications industry by replacing the traditional rotary dial with a dual-tone multi-frequency (DTMF) signaling system. This system uses a matrix-style keypad with buttons arranged in four rows and three columns, creating 12 distinct signals each assigned to a pair of frequencies. Each button press results in a simultaneous generation of two sinusoidal tones – one from a low-frequency group (697 to 941 Hz) and one from a...
320
Methods of Documentation VI: Case Management Model
561
The case management model is a multidisciplinary approach that involves healthcare professionals from diverse disciplines, such as physicians, nurses, therapists, social workers, and pharmacists, working collaboratively to address the various needs of patients. Each healthcare professional brings unique expertise and perspectives, contributing to a more comprehensive understanding of the patient's condition and tailoring treatment plans accordingly.
For example, a patient with a chronic...
For example, a patient with a chronic...
561
Methods of Documentation III: PIE
1.3K
Problem-intervention-evaluation (PIE) is a systematic approach to documentation used in healthcare settings for clinical decision-making and patient care planning. It is a structured approach to organizing patient data based on problems, interventions, and evaluations. Here's a breakdown of its key features and considerations:
1.3K
Methods of Documentation V: CBE
885
Charting by Exception, or CBE, is a method of documentation used in healthcare, particularly in nursing, that focuses on documenting only significant or abnormal findings rather than recording every detail. This approach aims to streamline the documentation process, improve efficiency, and ensure that healthcare providers can quickly identify deviations from normalcy in patient assessments.
In CBE, healthcare professionals establish predefined standards of practice that define what constitutes...
In CBE, healthcare professionals establish predefined standards of practice that define what constitutes...
885
Methods of Documentation IV: Focus Charting
1.0K
Focus Charting, also known as the focus charting system or "focus documentation," is a systematic documentation approach used in healthcare to organize patient information in medical records.
It typically involves three columns for recording information:
It typically involves three columns for recording information:
1.0K
Methods of Documentation I: Source-Oriented Records
1.1K
Source-oriented records, or SOR, are medical record-keeping organized by the data source. The SOR system was first developed in the mid-1900s to organize the growing patient data in hospitals and other healthcare facilities.
In an SOR, each discipline involved in patient care maintains a separate medical record section. This record-keeping method enables easy tracking of patient progress and ensures healthcare staff have access to up-to-date information.
Key Attributes include the following:
In an SOR, each discipline involved in patient care maintains a separate medical record section. This record-keeping method enables easy tracking of patient progress and ensures healthcare staff have access to up-to-date information.
Key Attributes include the following:
1.1K


