Project Management Stack Exchange
Project Management Stack Exchange

Questions tagged [documentation]

The documentation tag is for questions about documentation of processes and projects in the field of project management.

117 questions
13
votes
5 answers

Are the 'Project Charter', 'PID', 'SoW', and the 'Project Proposal' different names for the same thing?

This is a basic question that was asked on another site (a precursor to this site) but that seemed to be very helpful to visitors. Let me know if you find it useful. When initiating a project there are many different names for the base project…
Mark Phillips
  • 8,849
  • 4
  • 30
  • 57
9
votes
4 answers

Maintaining consistency over documents

In the company that I work for we have documents covering system requirements, standards, user acceptance, etc. each of these are maintained manually. If a change to the requirements is made then it has to be made in a couple of places, user…
Sam Jenkins
  • 191
  • 2
7
votes
7 answers

Project documentation (initiation, requirements, etc) on a WIKI versus requirements word document?

A team was having a debate where historically we had project documentation (requirements analysis, technical specs) put together large Microsoft word documents. Looking back over time, I have found issues with this approach, including: Lack of…
leora
  • 337
  • 2
  • 10
7
votes
6 answers

What document/diagram is must have for a software project?

I'm a newbie PM. I am a programmer before. So, what document/diagram is needed or better to have in a software project?
lovespring
  • 217
  • 1
  • 2
  • 7
7
votes
4 answers

Documenting institutional knowledge and legacy systems

I am a long-tenured employee at my company and have become the subject matter expert for our business rules and the reasoning behind them. Additionally, I'm the last person around that knows the legacy systems which means I'm often the bottle neck…
Dominic O'Connor
  • 173
  • 5
5
votes
3 answers

What is an "implementation plan"?

I was recently given the task of creating an implementation plan document. When I asked for an example of one that I could look at, I was told to look at the Project Plan that had already been created an use that as a base. I'm still a bit…
Abe Miessler
  • 151
  • 1
  • 3
5
votes
3 answers

Release Notes Best Practices

What are some tips for writing good release notes? Any best practices or examples? My audience is both my QA department and the executive team.
Mark Richman
  • 153
  • 1
  • 5
5
votes
3 answers

How to structure a "work package"?

Could someone give me the information about how one structures the s.c. "work packages"? I have never done this before but that's my task now. I need to describe use-cases, preliminary definitions, example workflows of the application, goals, I/O of…
azerIO
  • 153
  • 1
  • 1
  • 3
3
votes
4 answers

Create team activities that will lead to an improved documentation process

One of my goals for this year is to try to improve the documentation process within the R&D-department. My first step have been to sit down with each developer and talk about documentation in general and how they feel about our current documentation…
Patrik B
  • 125
  • 1
  • 7
3
votes
1 answer

Where can I find management documentation of industry projects?

I'm required to research an industry engineering project and analyse the way the project was managed over the project life cycle. Is there a resource where you can access real industry project's documentation involving the management of the…
wizzfizz94
  • 131
  • 1
3
votes
3 answers

Archiving Useful Documentation Without a PMIS

One of the most important project-management assets you build up during your project is documentation of all kinds of things -- how you broke down estimates, how much work you completed each work-period, what kind of risks actualized, etc. etc. and…
ashes999
  • 5,318
  • 28
  • 43
2
votes
2 answers

How to select a good Project Documents generation solution?

Within duration of project I often have to communicate various things to the clients. The projects I'm working on are very flexible, so often I receive from the client set of changes to implement and I estimate, provide and report on them. The forms…
XLII
  • 123
  • 2
2
votes
1 answer

Differences in perspectives for various types of documentation

In the current environment, there appears to be a subjective difference of opinions of the types of documentation and the level of detail required. For example, at what point is a document a design document, an as-built, technical specification and…
Motivated
  • 707
  • 4
  • 12
1
vote
2 answers

Is manuscript (handwritten documentation) used in project management?

In today's world, is there any place for manuscript documentation? Can manuscript be used nowadays? Some people still favor paper over digital media, then how to document such things? If developer develops some code then up to which extents…
Abhijit Shelar
  • 369
  • 3
  • 8
1
vote
1 answer

Defining a unified terminologies for a product?

When my team works on a project they usually come up with multiple names for the same thing. For example, if we have an Apartment entity, you might find some referring to it as an Apartment and others referring to it as a Flat. And so you see…
Unsuccessful Scrum Master
  • 23
  • 3
1
2