LinuxQuestions.org
Welcome to the most active Linux Forum on the web.
Go Back   LinuxQuestions.org > Forums > Linux Forums > Linux - General
User Name
Password
Linux - General This Linux forum is for general Linux questions and discussion.
If it is Linux Related and doesn't seem to fit in any other forum then this is the place.

Notices

View Poll Results: In a more formal repository, how would you prefer the question/problem summary?
a Question, ie, How do I install ... ? 1 20.00%
a Statement, ie, Installing application X on Linux. 4 80.00%
Other 0 0%
Voters: 5. You may not vote on this poll

Reply
 
Search this Thread
Old 02-22-2007, 04:07 PM   #1
jhibbets
Red Hat
 
Registered: Sep 2003
Location: Raleigh, NC
Distribution: Red Hat Enterprise Linux v 2.1, v 3, v 4
Posts: 174

Rep: Reputation: 30
Technical Information Preference - Survey


I'm working on a project that has an opportunity to make use of new technical writing guidelines. Let's say there are two sides to the technical information: 1) a fourm that is a Q&A presentation and 2) a more formal documentation repository or knowledgebase. The question I have:

In the more formal repository, would you prefer to have the "question" or problem summary stated as:
1) a Question, ie, How do I install ... ?
2) a Statement, ie, Installing application X on Linux.
3) Other.

Any feedback is welcome.

Last edited by jhibbets; 02-22-2007 at 04:09 PM.
 
Old 02-22-2007, 05:01 PM   #2
chadl
Member
 
Registered: Sep 2005
Location: US
Distribution: Gentoo AMD64 Testing
Posts: 129

Rep: Reputation: 16
In my opinion a statement looks more official then stating it as a question; so I would go with a statement. The benefit to phrasing it as a question is that it may catch more search queries from people who type "How do I install ..." into the search box (although Google and friends are fairly good at stripping out the worthless "how do I" part these days).
 
Old 02-23-2007, 08:39 AM   #3
XavierP
Moderator
 
Registered: Nov 2002
Location: Kent, England
Distribution: Lubuntu
Posts: 19,176
Blog Entries: 4

Rep: Reputation: 429Reputation: 429Reputation: 429Reputation: 429Reputation: 429
Much prefer to see a statement in official documentation. Questions are really more appropriate for forums. It also tends to be that manuals/documentation are telling us what we need to do so saying "This Is How To Perform a Task" seems more correct than "How Do I Perform a Task?".
 
  


Reply

Tags
information, survey


Thread Tools Search this Thread
Search this Thread:

Advanced Search

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is On
HTML code is Off


Similar Threads
Thread Thread Starter Forum Replies Last Post
Linux distribution preference survey JGD General 17 05-25-2006 10:02 AM
Suse technical information needed Crobat Suse/Novell 1 12-06-2005 11:18 AM
Which non-technical and technical book had changed or influenced you alred General 18 08-25-2005 08:44 PM
Browser Preference KeithKessler Linux - General 7 04-30-2003 12:36 PM


All times are GMT -5. The time now is 04:56 AM.

Main Menu
My LQ
Write for LQ
LinuxQuestions.org is looking for people interested in writing Editorials, Articles, Reviews, and more. If you'd like to contribute content, let us know.
Main Menu
Syndicate
RSS1  Latest Threads
RSS1  LQ News
Twitter: @linuxquestions
identi.ca: @linuxquestions
Facebook: linuxquestions Google+: linuxquestions
Open Source Consulting | Domain Registration