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.
RE: New position myself - need advice on requirements
Subject:RE: New position myself - need advice on requirements From:"Jonathan West" <jwest -at- mvps -dot- org> To:<techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 25 Apr 2007 10:18:09 +0100
> The developers have actually been working with
> the IT director for over 6 months now, and everybody
> figures they already know so much about what the
> outcome should act like, they don't need a design
> guide now.
That is the key point. If it is true, then the work you are being asked to
do to documents the BRs and FRs is useless, and you are wasting your energy
on documentation that at this time isn't needed and won't be used.
But if it turns out that while everyone thinks they know how it should work,
they don't all have an *identical* understanding, then there is an urgent
need for an authoritative document which codifies the requirements and irons
out any misunderstandings.
So your first task should be to see if there are any discrepancies in what
people think the outcome should be. That doesn't just mean in terms of user
interface, but also in the overall feature set and in the APIs between the
code blocks being produced by different elements of the team. Take those
findings (however they turn out) to your boss, work out with him what
conclusions need to be drawn from them, and get him to give you orders as to
how to proceed from here. By all means suggest to him a possible course of
action, but it is most important that he takes ownership of the decision,
because whatever you do (or more accurately, whatever you decide not to do)
is going to put somebody's nose out of joint. As a new hire you need
management cover in such a situation.
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
Now shipping: Help & Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help & Manual: http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-