Talk:Software documentation

This is the talk page for discussing improvements to the Software documentation article.
This is not a forum for general discussion of the article's subject.

Put new text under old text. Click here to start a new topic.
New to Wikipedia? Welcome! Learn to edit; get help.

Article policies

Find sources: Google (books · news · scholar · free images · WP refs) · FENS · JSTOR · TWL

Software: Computing Start‑class Mid‑importance

	This article is within the scope of WikiProject Software, a collaborative effort to improve the coverage of software on Wikipedia. If you would like to participate, please visit the project page, where you can join the discussion and see a list of open tasks.SoftwareWikipedia:WikiProject SoftwareTemplate:WikiProject Softwaresoftware
Start	This article has been rated as Start-class on Wikipedia's content assessment scale.
Mid	This article has been rated as Mid-importance on the project's importance scale.
	This article is supported by WikiProject Computing.

User Docs Old Hat

User documentation for software, especially complex software, is a thing of the past. Big, money-making software publishers believe GUIs have eliminated the need for good user documentation, because the point-and-click paradigm is so simple, so self-explanatory, a child could use it. Of course, this is a rationalization that, in a way, justifies not spending a dime on explaining how their highly profitable products may be used, since people can "discover" what they need to know by fooling around. Alternatively, context-sensitive help may be perceived as a substitute for use case by usage scenario coverage of every feature. The people in the best position to publish effective user documentation (because they understand the motivations and the details) don't do it. So technical publishers hire technical writers who take a stab at the task and fail as often as they succeed to fill the gap. Such a shame!--72.75.76.186 02:49, 20 December 2006 (UTC)[reply]

In the Electronic Design Automation software industry, good documentation is necessary. It is printed documentation that is no longer produced. There isn't a culture where the vendor expects to sell you several, (tens-of), thousands of dollars worth of software license then expects you to buy a book to learn all the really useful stuff about how to use the software - There are no 'Clock-insertion for dummies' books. --Paddy 04:14, 21 December 2006 (UTC)[reply]

section: Architecture/Design Documentation

Should clarify what IS means in "outline what the IS situation is". --AlastairIrvine 03:24, 1 May 2007 (UTC)[reply]

Merging with HOWTO

This is silly. Software documentation is a broad concept that covers many many things. A Linux HOWTO is a specific instance of software documentation. Merging HOWTO into Software Documentation would be like merging Apple into Fruit. 66.80.155.65 (talk) 18:37, 15 May 2008 (UTC)[reply]

Against. As stated above software documentation is a broad topic and HOWTO is discretely different Paullb (talk) 08:09, 23 October 2008 (UTC)[reply]

Against. The topics, as in their generality, are different. Software documentation is a broad topic entirely focused on software, of which software HOWTO is a particular type. HOWTOs are manuals / instruction procedures and in their generality can be referred to anything, software included. —Preceding unsigned comment added by 210.254.37.34 (talk) 05:21, 31 July 2009 (UTC)[reply]

Bad reference?

I can't find anything leading to the following statement in the reference provided. How about a page number or a link to the actual page?

"Tutorial: A tutorial approach is considered the most useful for a new user, in which they are guided through each step of accomplishing particular tasks [1]." ^ 1. Woelz, Carlos. "The KDE Documentation Primer". http://i18n.kde.org/docs/doc-primer/index.html. Retrieved 15 June 2009. —Preceding unsigned comment added by 86.27.207.197 (talk) 17:13, 22 April 2010 (UTC)[reply]

Web site design

Yes ... the design is clearly needed to be changed :) What would be brighter , nebudu ( — Preceding unsigned comment added by 93.85.180.81 (talk) 17:42, 22 May 2012 (UTC)[reply]