TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:RE: Including third-party Linux documentation? From:John Posada <JPosada -at- book -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Fri, 9 May 2003 16:25:19 -0400
>I'm working on a new SysAdmin guide for users who will be Linux experts.
1) But they're not Linux experts now?
if that is the case, you cannot expect them to be savvy.
2) When the guide is done, it is for users who are already Linux savvy
if that is the case, don't include too much. However...I'm not a Linux
master, but isn't there slight differences in different Linux flavors? Maybe
syntax differences? Is your documentation for an audience where you know
what flavor? If not, maybe include items where a Linux flavor would have an
impact.
-----Original Message-----
From: fbelton -at- octigabay -dot- com [mailto:fbelton -at- octigabay -dot- com]
Sent: Friday, May 09, 2003 2:56 PM
To: TECHWR-L
Subject: Including third-party Linux documentation?
Hi all,
I'm working on a new SysAdmin guide for users who will be Linux experts.
Obviously I don't want to describe the Linux commands and syntax in great
depth in my guide, but am wondering how to make sure all the bases are
covered. Specifically:
- Is it enough to say that users are expected to be Linux savvy in the
document intro and leave it at that?
- Or do some companies also package a basic "off-the-shelf" Linux manual
with their own in-house manuals, and then simply refer to the
off-the-shelf manual when appropriate?
---
You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.