Teaching to Write Software Engineering Documents with Focus on Document Design by Means of Mind Maps

Koznov, Dmitrij V.

doi:10.2316/p.2012.774-036

Cited by 5 publications

(3 citation statements)

References 10 publications

Supporting

Mentioning

Contrasting

Order By: Relevance

“…. Rework Koznov (2012) points out the issue of poor technical documentation and how there are approaches to make the teaching of proper documentation easier. Regarding one of such approach he states that "changing design is faster than rewriting the text."…”

Section: Resultsmentioning

confidence: 99%

Learning from West African storytellers

Bakare,

Ciancarini,

Farina

et al. 2023

Front. Comput. Sci.

View full text Add to dashboard Cite

Several research works propose non-textual alternatives to textual documentation and similar forms of representing information in software development. This is because of the problems that stem from writing these documents, which range from incomprehensible requirements to ambiguous user stories. The various proposals of researchers often contain some trace of oral or visual communication. In this paper, we study the implications of eliminating textual communication and substituting unnecessary writing by extracting the values of West African oral storytellers. Traditional West African communities did not make use of writing for thousands of years and yet their legends, customs, beliefs, and knowledge were effectively transmitted across several generations. How did they manage to accomplish this? What can we learn from their storytellers? How can these lessons be applied to software products? These are all questions that this paper attempts to answer. Perhaps if we fully understand how they operated, then we can target our written communication to the activities where it is needed instead of spreading writing across plenty of tasks as it is currently. To achieve this, we performed an analysis of the two domains: West African oral storytelling and software development and found similarities, then selected some key elements from oral storytelling and explained how they can have relevance in software development. The theme directly encompasses diversity and inclusion by bringing into software engineering a perspective of a region where its literacy research is scarcely being explored. The study found that traditional oral storytelling can provide insights into effective communication and audience engagement, and identified four ways in which software development can be compared to oral storytelling. The study also found that certain elements of storytelling, such as audience relationship, story structure, parables and proverbs, and community relaxation and support, can be applied to writing tasks in software development.

show abstract

Section: Resultsmentioning

confidence: 99%

Learning from West African storytellers

Bakare,

Ciancarini,

Farina

et al. 2023

Front. Comput. Sci.

View full text Add to dashboard Cite

show abstract

“…SMEs can play a vital role in assisting and fostering entrepreneurial activity with a special focus on information technology businesses [4]. A variety of effective approaches to knowledge transfer is implemented through a variety of visual tools and models [2][3][4][5][6][7][8][9]. Comprehensive training in engineering specialties is largely based on visual tools that ensure the creation, transmission,and application of mechanisms for the formalization and manipulation of knowledge in a single semantic interdisciplinary and interspecifi c hierarchy, providing a single and complete description of the product life cycle processes [10,11].…”

Section: Introductionmentioning

confidence: 99%

“…The postulate "one picture replaces 1000 words, and one diagram 1000 drawings"has already become classic. Among the levels of visual models of knowledge representation about production systems, fi rst of all, it is required to single out conceptually-abstract [6], structural-functional [7], and object models [8]. The research on the methods of synthesis of a set of valid, reproducible and systemic methods and means of visual description of the processes occurring in complex systems is relevant.…”

Section: Introductionmentioning

confidence: 99%

Visual environment of cognitive graphics for end-to-end engineering project-based education

Vlasov¹,

Juravleva²,

Shakhnov³

2019

J Appl Eng Science

View full text Add to dashboard Cite

This article is concerned with the prospects for the implementation of synchronous technology for knowledge processing and transfer by visual methods in the context of end-to-end engineering project-based training. A formal characterization of information about complex systems based on the visual cognitive metalanguage VI-XML, forming a synchronous project-based educational environment, is proposed. This environment is a set of methods, using visualization metaphors, while the object under study is presented from different points of view and levels of detail (expertise). Visualization metaphors form the mechanisms for processing and transferringknowledge by comparing abstract or real objects to visually perceptible images. Visual modeling languages, in turn, are formed by fi xed sets of metaphors and rules for construction of visual models from them. The proposed approach to the presentation of models underlies the universal visual modeling environment, which provides a single interface for creating and editing visual conceptual, structural-functional, and object models. It provides the ability to encapsulate the levels of visual modeling in a single closed hierarchy, accompanying the stages of system analysis and design. The experience of using a universal visual modeling environment in the frame of practical work and group design has proven itself to be good for the solution of educational problems in the fi eld of knowledge transfer in a visual form that is easily interpreted by students.

show abstract