Use a Pencil: On Writing Software Documentation Well and the Role of Autodocumentation

Phil Laplante

doi:10.1109/MC.2024.3374008

Use a Pencil: On Writing Software Documentation Well and the Role of Autodocumentation

Phil Laplante

Research output: Contribution to journal › Comment/debate › peer-review

Abstract

Proficiency in technical writing is an important skill that all software engineers should develop, but there is a trend toward automation of documentation. This article discusses the past, present, and future of software documentation.

Original language	English (US)
Pages (from-to)	102-105
Number of pages	4
Journal	Computer
Volume	57
Issue number	5
DOIs	https://doi.org/10.1109/MC.2024.3374008
State	Published - May 1 2024

All Science Journal Classification (ASJC) codes

General Computer Science

Access to Document

10.1109/MC.2024.3374008

Cite this

@article{65a7edc9ef6f4a22ac27a25637612f01,

title = "Use a Pencil: On Writing Software Documentation Well and the Role of Autodocumentation",

abstract = "Proficiency in technical writing is an important skill that all software engineers should develop, but there is a trend toward automation of documentation. This article discusses the past, present, and future of software documentation.",

author = "Phil Laplante",

note = "Publisher Copyright: {\textcopyright} 1970-2012 IEEE.",

year = "2024",

month = may,

day = "1",

doi = "10.1109/MC.2024.3374008",

language = "English (US)",

volume = "57",

pages = "102--105",

journal = "Computer",

issn = "0018-9162",

publisher = "IEEE Computer Society",

number = "5",

}

TY - JOUR

T1 - Use a Pencil

T2 - On Writing Software Documentation Well and the Role of Autodocumentation

AU - Laplante, Phil

PY - 2024/5/1

Y1 - 2024/5/1

N2 - Proficiency in technical writing is an important skill that all software engineers should develop, but there is a trend toward automation of documentation. This article discusses the past, present, and future of software documentation.

AB - Proficiency in technical writing is an important skill that all software engineers should develop, but there is a trend toward automation of documentation. This article discusses the past, present, and future of software documentation.

UR - http://www.scopus.com/inward/record.url?scp=85192744185&partnerID=8YFLogxK

UR - http://www.scopus.com/inward/citedby.url?scp=85192744185&partnerID=8YFLogxK

U2 - 10.1109/MC.2024.3374008

DO - 10.1109/MC.2024.3374008

M3 - Comment/debate

AN - SCOPUS:85192744185

SN - 0018-9162

VL - 57

SP - 102

EP - 105

JO - Computer

JF - Computer

IS - 5

ER -

Use a Pencil: On Writing Software Documentation Well and the Role of Autodocumentation

Abstract

All Science Journal Classification (ASJC) codes

Access to Document

Other files and links

Fingerprint

Cite this