Questions tagged [documentation]

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

Filter by
Sorted by
Tagged with
21
votes
13answers
14k views

Is it correct to refer to a 'post mortem' session even for successful projects?

It might be a silly question for non-latin speakers, but it's odd to hear about a post-mortem meeting for a successful project since this expression means 'after death'. I know that this can be also ...
21
votes
6answers
115k views

PMP Experience Documentation [closed]

I am looking to take the PMP exam in a year or so, and see that one of the requirements is "at least three years of project management experience, with 4,500 hours leading and directing projects." ...
14
votes
9answers
2k views

How do you encourage project members to document their work for end-of-project handover?

It seems that the worst aspect of any project is documentation - what developers have done, what contractors delivered, who owns what, how to support the end result, etc. How do you encourage all ...
14
votes
6answers
3k views

How and What to Learn - New to Product Management [closed]

What documentation, skills & tasks should a new (Technical) Product Manager concentrate on learning first to effectively do their job? I have read this Wikipedia article, and it didn't answer my ...
13
votes
8answers
997 views

How to motivate my team members to start documenting their work

I just started a new job as a technical project manager. It's more or less my first experience, as I have just run teams of two students before, and now I am managing a project of 10 engineers, some ...
13
votes
5answers
13k views

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 ...
11
votes
5answers
2k views

Where does documentation like business and software requirement spec docs fit in an agile project?

We are implementing scrum in our company. The problem we faced is our traditional thinking, which always requires physical document. Management is constantly asking for documents like Business ...
10
votes
5answers
2k views

What are the metrics for software documentation?

I would like to get information about measurements and metrics for documentation work in a project. The project can be itself limited to documentation as a deliverable or documentation as part of ...
10
votes
2answers
897 views

How much code documentation should an effective Scrum Team produce?

As part of the audit and compliance for my company (PLC), any Agile Projects are treated as a normal Waterfall Projects for review purposes although run according to Scrum best practice. We don't ...
10
votes
2answers
23k views

What percentage of a project manager's time should be spent working in the project management software and documentation?

What percentage of the project manager's time is spent planning, writing tasks, and tracking time in the project management software? How much time should be given to documentation? Every position ...
9
votes
4answers
702 views

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 ...
9
votes
1answer
3k views

How should technical writers fit within a Scrum team?

I think my company could benefit from adding a technical writer to the team; making sure our output is unified and of a high quality. For our current project we need to produce a range of documents, ...
8
votes
4answers
150 views

What information do you keep about a project once it has been completed? [closed]

Once a project reaches completion, which information do you keep/store for your records? Do you only keep a record of lessons learned, or do you also keep other project-specific information?
7
votes
8answers
550 views

What is the preferred number of tasks to assign?

I am going to lead a small team for the first time in my career and I am determined to not subject my team to the same issues that I perceive to have been subjected to as a programmer. This question ...
7
votes
5answers
1k views

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 ...
7
votes
5answers
408 views

What is good criteria for deciding what constitutes an individual task?

My own background is in software dev and I've started work as a network engineering PM recently. In my previous PM work, creating documentation was a separate task. It was sometimes done by the ...
7
votes
3answers
18k views

Evidences and experience letter for PMP

I am working in one of the very big petrochemical project from IT construction to startup. I'm still working there. I have been working in the operations department, not exactly in project ...
7
votes
2answers
7k views

SRS for an Agile project

Currently, I am drafting a SRS ( Software Requirement Specification ) doc for an agile project, and the samples are the ones used in a waterfall project. I did google a lot but couldn't find any right ...
7
votes
6answers
2k views

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

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

Is there any alternative to MS-Project server to build a collaborative deployment plan?

Objective Questions: How do you guys coordinate cross-team deployment plans? Are you still using the old school Excel for these plans? How do you rearrange tasks in a way the dependencies between ...
6
votes
6answers
215 views

Does it make sense to require developers to write a “business value add” section in each issue?

Background In our company we demand that engineers write a brief one liner section in each ticket they work on (from jira/github/gitlab etc) that explains the "business requirement".. the logic of ...
6
votes
5answers
641 views

How can we speed up code reviews without sacrificing thoroughness of the code reviews?

At our workplace, we use Agile Scrum method. However, we don't really follow it religiously. But, we do very thorough code reviews. The problem with code reviews is that it's takes a while to ...
6
votes
4answers
374 views

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 ...
5
votes
3answers
6k views

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.
5
votes
2answers
2k views

Documenting requirements on an Agile project

One of the values of the Agile Manifesto is "working software over comprehensive documentation". And yet there is a need for requirements to be documented. If a feature developed 6 months ago is ...
5
votes
2answers
305 views

How can I connect Project Issues to Project Deliverables in a Post-Mortem document?

I'm conducting a Post-Mortem Review with Senior Management, regarding a project that had multiple unfulfilled/half-fulfilled deliverables that caused issues for clients. The deliverable for the Post-...
5
votes
2answers
127 views

How does one bridge the gap in producing deliverables between operations and projects?

As with most reasonable sized organizations, the current organization has an operational team and a project team which drive varying degree of initiatives. Unlike any other organization i have ...
5
votes
3answers
4k views

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 ...
5
votes
3answers
13k views

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, ...
5
votes
3answers
3k views

What are the metrics for a good SRS (Software Requirement Specification)?

I have been searching but all that I have found is the characteristics of a good SRS (Software Requirement Specification). What are the metrics that you could use to ensure that the set of ...
5
votes
2answers
1k views

Technical Specification Tools [closed]

I am planning to write a technical specification document / functional specification for my personal project. Can anybody suggest any useful links / tools / templates that can help me? I am mainly ...
4
votes
3answers
2k views

Software project workflow template for the lonely programmer?

My problem is simple: I am the only software developer in an organization trying to start organizing projects for me. Management directors don't care and ignore EVERYTHING about corporate governance ...
4
votes
2answers
297 views

Documents needed for everyday changing requirements

I am working on a project in which almost everyday we get new requirements that need to be done ASAP. Probably, this is what the client wants. I am curious to know if this is call "Agile" project. ...
4
votes
2answers
478 views

Who should see the Vision and Scope document?

We're about to meet some influential people on my project's field (at least they're influential in my country), data mining, mainly looking for some advice and, why not, a possible alliance in a mid ...
4
votes
2answers
11k views

How to track change requests over a functional document

Functional requirements tend to mature as the time goes by, and the initial versions of requirements for a project are usually based on assumptions (otherwise the work would never start). As the ...
4
votes
2answers
949 views

What artifacts does Scrum require for application design and systems documentation?

I have been a developer for awhile. Recently, I got promoted within my team. Now I am responsible for application design and documentation, and am thinking of following the Scrum methodology. We are ...
4
votes
3answers
399 views

2 years of Dev Experience to a Project Manager

I have a 2 years of .NET experience in enterprise architecture. Plus I hold a Masters Degree in Management (Not MBA, 1st yr of MBA). Now I am moving to a software consulting company of less than 50 ...
4
votes
4answers
558 views

Where to find good PM documentation? [closed]

I'm currently working as project lead(prince2 certified) since a few months and find it very interesting to see how other PMs solve problems, react to situations, use tools, etc. StackExchange is ...
4
votes
3answers
366 views

What are the best ways to specify project deliverables to non technical persons

I have a list of deliverables below (draft) Client Side User interface design for mobile app Registration module to allow end user register to the system by providing their personal information and ...
4
votes
1answer
63 views

Managing large lists of acronyms and terms

Our current client sent us several hundred pages of documentation about the context and goals of his company. In these documents (there are multiple files) they use a lot of acronyms and very specific ...
3
votes
5answers
907 views

How to refer to functional requirement specifications (FRS) from user stories?

Let's consider a simple story for a user authentication screen: As a user, I want to be able to login with my username and password so that I can do xyz. This looks good, but all of the ...
3
votes
3answers
2k views

Failed to finish project in time, now threatened with UK court [closed]

I wonder if anyone has experience and can help with some advise. I am a programmer with 15 years of experience, and I feel it is unfair what is happening to me. I was silly enough to sign a ...
3
votes
3answers
4k views

What are the required documents should I prepare In order to start my Project

I am preparing to start my new project which is Developing open source ERP System What really I am confusing about: How to start : what is the first step should I begin with. ( Preparing the ...
3
votes
4answers
383 views

How should a project manager handle a request for contracted software to produce twice as many reports as specified in the project's requirements?

I have joined a late-phase software project and there is a great deal of disagreement between my management and the client about work items they are claiming to be outstanding. In short, our business ...
3
votes
4answers
2k views

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 ...
3
votes
2answers
2k views

Project Management Document to prepare for Technical Team Leader

I am recently promoted to team lead, with this, my organization has also recently started to following the process of software development life cycle, but so far not too many things are streamlined. ...
3
votes
1answer
16k views

What a good Lessons Learned paper should include?

I'm preparing a Lessons Learned paper and I wonder what such paper should contain. I found this post: http://www.ehow.com/how_8014106_write-lessons-learned-report.html, some of the points listed there ...
3
votes
3answers
308 views

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-...
3
votes
2answers
167 views

How do you keep documentation on long-term project?

I'm working on optimizing the process of documentation on the projects in IT company. The issue is that right now the company has documentation when the project is started but then they don't ...
3
votes
1answer
170 views

How to document existing products and their development?

My product have been going for almost three years without any product requirement or documentation at all. And at this moment things are getting out of hands. For example when I hire new people, it ...