Talk:Software documentation

From Wikipedia, the free encyclopedia
Jump to: navigation, search
WikiProject Software / Computing  (Rated Start-class, Mid-importance)
WikiProject icon 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.
Start-Class article Start  This article has been rated as Start-Class on the project's quality scale.
 Mid  This article has been rated as Mid-importance on the project's importance scale.
Taskforce icon
This article is supported by WikiProject Computing.

User Docs Old Hat[edit]

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!-- 02:49, 20 December 2006 (UTC)

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)

section: Architecture/Design Documentation[edit]

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

Merging with HOWTO[edit]

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. (talk) 18:37, 15 May 2008 (UTC)

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

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 (talk) 05:21, 31 July 2009 (UTC)

Bad reference?[edit]

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". Retrieved 15 June 2009. —Preceding unsigned comment added by (talk) 17:13, 22 April 2010 (UTC)

The main problem now is not bad references, but no references. I think part of the problem with many articles relating to technical communication and documentation is that we as subject matter experts take what we do for granted, using these genres without studying or explaining them. A layperson viewing this entry will have no idea of the significance of this subject. I think the main goal right now should be to find academic sources simply explaining what software documentation is and using those sources to support the already existing content in the article. MezzoMezzo (talk) 12:31, 25 February 2013 (UTC)

Marketing documentation[edit]

Why is that section even in this article? Marketing software and documentation for software are two different things. I would suggest merging the section into another article, but given the fact that it's unsourced, I suggest that it simply be deleted; it has no relation to the topic. MezzoMezzo (talk) 09:42, 26 February 2013 (UTC)


asdsd — Preceding unsigned comment added by (talk) 19:50, 29 October 2013 (UTC)