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:Request for a metadocument From:Sandra Law <sandra -dot- law -at- quest -dot- com> To:'TECHWR-L' <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 20 Jul 2000 07:46:32 -0700
Documents with the characteristics that you describe may be referred to as
Engineering Requirements Documents (ERD)or Product Requirements Documents
(PRD). Documents of these types that I have encountered can have the
following components:
ERD
Purpose (generally state what deliverables will be, any enhancements to
product)
Development Plan
Prioritization of tasks
Project Details
Installation info
Configuration info
Listing of modules or components
Naming standards.
PRD
Purpose
Scope and Audience
Definitions & Acronyms
Product Description
Goals
-Features
-Updates
-Marketing
Milestones
Project Details
-Enhancements
-New Features
-Upgrades and Patches
The PRD resembles a Project Plan.
Not complete I realize but gives you some idea of content.
Sandra Law
-----Original Message-----
From: Roderick Jons [mailto:Roderick -dot- Jons -at- liffe -dot- com]
Sent: Wednesday, July 19, 2000 7:34 AM
To: TECHWR-L
Subject: Request for a metadocument
Does anyone have a metadocument for a large software system project?
Meta is meant to be "an underlying definition or description." For
instance, metalanguage is a definition or description of language. An
English grammar and dictionary together could be said to define (and
describe) the metalanguage for English.
The sort of thing I am looking for would include functional specs,
overviews, logical specs, etc; plus a brief definition of each.
