Stack Exchange Network

Stack Exchange network consists of 174 Q&A communities including Stack Overflow, the largest, most trusted online community for developers to learn, share their knowledge, and build their careers.

Visit Stack Exchange

Questions tagged [documentation]

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

2
votes
1answer
26 views

Tracking and closing actions being addressed by other working groups

I work for a chain of hospitals which have annual inspections by the healthcare regulator. Following the inspections an action plan is created to address any issues identified during the inspection. ...
0
votes
1answer
21 views

How to name written data that it will likely be used later in the project?

How can I give a general name for documented data that will likely to be accessed and used in the future? Data like: outline of summary of a meeting. a list of links, found after a research session. ...
1
vote
5answers
95 views

User documentation and technical writer in Scrum

If User documentation is part of the definition of done and there is no technical writer in the scrum team, how the situation is dealt? Should the dev team create user documentation still or wait ...
4
votes
1answer
50 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 ...
0
votes
2answers
62 views

Managing product versions in Confluence with PRDs

Using Confluence I put together a series of PRDs for a future release. Each PRD describes a functional 'unit' of the application, such as 'editor', 'user management', 'customer management', etc. Using ...
0
votes
2answers
99 views

Is it really always bad to have MS Outlook as primary collab system? [closed]

I work in a high tech software engineering in a small RnD group which is a part of a group of about 50 people of different functions. In our small team we tried multiple project management software ...
0
votes
1answer
46 views

How to write recommendation documentation? [closed]

I was asked to prepare an overview of an existing IT architechture and provide a document that consists of weaknesses analysis and suggestions on how each of the weak spots can be improved. How to ...
-2
votes
3answers
69 views

list of all project documents? [closed]

Can someone list down all documents required for project management like planning document, risk management, time plan etc....
0
votes
3answers
79 views

Where to start in agile-based documentations and what are the best practices to start with?

We're currently working on our documentation and we sort of followed Scrum. Which diagrams, charts, figures, and etc should I include in our documentation? Also, what are the best practices in ...
-1
votes
2answers
224 views

What is a project book?

I've been talking with a PM instructor and they said their PM students needed to put together a project book as part of their assessment. I've not heard of this, except referring to all the ...
0
votes
1answer
59 views

How to manage misalignments between Design Specs and After Design Adjustments?

How do you manage this scenario? UX and Visual design a feature. PO and DEV decided -after design got approved- to ignore some specs of implementation, so we have something different than the design ...
2
votes
1answer
350 views

What documentation is required for behavior-driven development?

I have been asked to provide some behavior-driven development documents for a project which has not yet started. This leaves me thinking, "other than stories yet to be written, what documents are ...
-4
votes
3answers
51 views

What documents a client should get at the end of a project [closed]

I want to build a list of useful documentation that a client can find useful, both during and after use of the system built in a project. I think that system requirements, high level and low level ...
3
votes
1answer
106 views

Where can I find management documentation of industry projects? [closed]

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 ...
6
votes
6answers
187 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 ...
4
votes
2answers
761 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 ...
0
votes
2answers
59 views

Types of audits in service IT industry [closed]

I have seen many job descriptions for project managers in which organizations want the candidate should have been worked on different audits and audit reporting. I have 2 questions: Kindly explain ...
5
votes
5answers
493 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 ...
-3
votes
2answers
97 views

Best solution for team managment [closed]

We are using three tools for handle our jobs, Slack for communication Trello for Task Management Google Docs for Documentation because these tools have not good integration with each other ( and ...
3
votes
1answer
112 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 ...
0
votes
3answers
336 views

How to write a good Critical Success Factor?

Can you share some of your tips and tricks on how to pull out the information from stakeholders in order to write good CSF? What questions do you ask to get to the heart of the project? Can you ...
0
votes
1answer
326 views

Tracking requirements

I am having a difficult time understanding how requirements are tracked through the project. I have a list of requirements - do I link these to deliverables during planning? Do i periodically ...
3
votes
4answers
227 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 ...
1
vote
2answers
81 views

Can planning documents be retroactively produced to fit the product that's been built?

I am currently implementing an Android application and am struggling to do my class and sequence diagrams, predominately due to the fact that the specifications are too abstract and vague. I was ...
12
votes
8answers
665 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 ...
2
votes
1answer
111 views

When does one develop a RASCI?

Generally I see a Responsibility Assignment Matrix (RASCI) being developed at the start of a project. However, in the current environment, a RASCI is only being developed as part of handover to the ...
2
votes
1answer
65 views

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

Documenting business & technical decisions, changes, updates and so on

After years of experience in software development, I've not yet come up with a best practice for documenting business & technical decisions and requirements. For instance, I want to know why we ...
1
vote
1answer
141 views

What is the correct way to handle delays caused by technical issues?

I am working on a Web Design and Development project for my Final. I have missed Alpha and Beta milestones due to a critical server error that was beyond my knowledge or understanding. I had to get in ...
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
2answers
506 views

What artifacts should be created during the lifecycle of a project?

Looking at the lifecycle of a project, is there a industry standard (not specific to only project management) or a set of best practices of the artifacts that should be created as part of a project? ...
5
votes
2answers
107 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 ...
2
votes
1answer
109 views

Is there a document management system or process that keeps track of child/forked documents?

I may need to cross-post, but I'd see if anyone has experience with this project management issue. We have a core document, say, a series of standards, that, based on that, we create solution guides, ...
0
votes
1answer
940 views

Documents to create prior to Kick-off Meeting [closed]

We have gotten approval of our Project Charter and have a kick-off meeting scheduled already and I'd like to know what documents do I need to create prior to this kick-off meeting and/or what ...
2
votes
2answers
3k views

What does MOS and RA stand for in IT project?

My customer asked if I can do an MOS and RA. RA should be risk analysis if I'm not mistaken. But what is MOS?
8
votes
2answers
797 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 ...
4
votes
3answers
333 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 ...
0
votes
3answers
141 views

Which common file naming schemes are available for project management?

Are there ISO (or other) standards which suggest a naming scheme for office files like Q-2014-01-02_ObelixAndCo.pdf (example for a quotation) O-2014-01-04_ObelixAndCo.pdf (example for an order ) D-...
4
votes
2answers
10k 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 ...
8
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, ...
6
votes
4answers
353 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 ...
1
vote
3answers
547 views

What should be included in a comprehensive “plan of attack” document?

Its common for most software development processes to begin with a plan of attack, in which you could find the following topics: The context of the clients company A summary of the business processes ...
6
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
381 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 ...
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
1k 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 ...
9
votes
4answers
561 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 ...
1
vote
1answer
442 views

How best to 'leanify' test case documentation?

I'm currently reviewing some test case artifacts for various project teams as standardized by our organization. However, I'm a bit appalled to find that a lot of content is being captured in documents ...
-2
votes
2answers
2k views

Documenting PMP Experience [duplicate]

Possible Duplicate: Can I apply for PMP without experiences in all processes? What are the requirements for obtaining these certifications? I am a new member here and getting ready to take my PMP ...