Automatic Generation of Usage Manuals for Open-Source Software

Yukikazu, Murakami; Yuki, Hori

doi:10.1109/cisis.2012.100

Search citation statements

Order By: Relevance

Paper Sections

Select...

Create a User Manual1

Citation Types

Supporting

Mentioning

Contrasting

Year Published

2019

2020

Publication Types

Select...

Article1

Other1

Relationship

Self Cite0

Independent2

Authors

Journals

Cited by 2 publications

(1 citation statement)

References 4 publications

Supporting

Mentioning

Contrasting

Order By: Relevance

“…Writing user manuals is not like commenting on the code. Code comments are only used by developers to understand a given code whereas manuals are mainly for nontechnical persons including users [47]. The main advantages of software user manuals are:  They are used to describe the software functionality.…”

Section: Create a User Manualmentioning

confidence: 99%

Best Practices and Recommendations for Writing Good Software

Sarhan

2019

juod

View full text Add to dashboard Cite

Writing good software is not an easy task, it requires a lot of coding experience and skills. Therefore, inexperienced software developers or newbies suffer from this critical task. In this paper, we provide guidelines to help in this important context. It presents the most important best practices and recommendations of writing good software from software engineering perspective regardless of the software domain (whether for desktop, mobile, web, or embedded), software size, and software complexity. The best practices provided in this paper are organized in taxonomy of many categories to ease the process of considering them while developing software. Furthermore, many useful, practical, and actionable recommendations are given mostly in each category to be considered by software developers.

show abstract

Section: Create a User Manualmentioning

confidence: 99%