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: Query related to SLDC and audits From:"Cliver, Barry" <CliverBarry -at- PRAIntl -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Tue, 12 Apr 2005 07:56:31 -0400
>>1. Are technical writers given a full-length description about the
various stages of Software Development Life Cycle in real-life
Technical writers write SDLC documentation. If you're writing it, then
you need you to research SDLC and the subject about which you're
writing. I wouldn't expect anyone to give you anything. You need to find
out who will approve the SDLC documentation, usually a senior
decision-maker in the organization.
I believe the IEEE created the structure for System (not software)
Development Life Cycle documentation. SDLC doc is commonly done for
organizations involved in healthcare, financials, government, and more
recently, accounting systems subject to Sarbanes-Oxley.
>>2. Why is Auditing so important in SLDC? Can a Technical Writer be
involved in Auditing?
An organization writes SDLC doc to satisfy auditors, both internal and
external. Auditing is performed to ensure that the organization's
standards and practices are being followed. No where is that more
visible than in SDLC doc.
Yes, the technical writer is absolutely involved in explaining the SDLC
doc to auditors. You need to know what people/companies/regulatory
agencies will audit you. Most auditors won't tell you how to document
something. That's up to you.
WEBWORKS FINALDRAFT - EDIT AND REVIEW, REDEFINED
Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo: http://www.webworks.com/techwr-l
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.