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
0
votes
1answer
15 views

How to automate inclusion of confluence design docs in Requirement traceability report on Jira

If an organization is regulated, it has to pass the audit and show that it has implemented a "requirements traceability". This means it has documented the path from a specific requirement to ...
1
vote
2answers
71 views

User story/acceptance criteria for page with a lot of content

I've recently been tasked with writing user stories and acceptance criteria (GWT) and would like to ask for advice since I'm relatively new to such approach. A bit of context: Project is a web app ...
1
vote
2answers
64 views

Is Change log the same as Change Request log? Aren't there other changes than CRs?

Browsing through some PM topics, I have realized that most sources use the Changelogs and Change Request logs interchangeably. But is that correct? I am not a PM, but aren't there often changes that ...
2
votes
1answer
51 views

Design Specification Ownership: how to protect it from obfuscation and excessive adjustments on Enterprise project?

By Design Specification Ownership I mean that nobody can read it right as expected except the author/ideologist/creator. If a person works on the same project for a long time and keeps the same ...
1
vote
4answers
68 views

While preparing a Developer level Document (Use Case) what should be defined in Business Validation?

We are working on a developer-level document or a Use Case document which is shared with the development team. We define Business Validation within a use case, what should be a part of that Business ...
0
votes
2answers
230 views

What should be Assumption for a network project?

I am working on providing wireless infrastructure suggestions to a client like what software, hardware and equipment will be required to a client in order for them to set up the wireless ...
1
vote
2answers
486 views

What should be cover in Functional and Non-Functional requirements for a network project?

I am working on providing wireless infrastructure suggestions to a client like what software, hardware and equipment will be required to a client in order for them to set up the wireless ...
2
votes
1answer
52 views

Does Jira have the ability to create product documentation from tickets

I have been in meetings with product managers discussing how to document our app when something dawned on me. If we spend all of this time creating the Jira infrastructure to manage Epics/User-...
0
votes
2answers
82 views

Is there a reason this is labeled as 'Finish to Finish' even though 'Finish to Start' makes more sense?

Got this question in my course: You are managing a software project. Your QA manager tells you that you need to plan to have her team start their test planning activity so that it finishes just ...
-4
votes
1answer
149 views

What are the key documents involved in a software project? [closed]

From project proposal to Delivery - in the software development, Which all documents are involved and What is the order? While using Agile development, including SRS, DB structure, source code ...
1
vote
1answer
148 views

SRS for project with multiple sub modules

I have to write a System Requirements Specification for an upcoming project and it is the first time that I draft such a document. In my case we are creating a smartphone App which will have a basic ...
3
votes
5answers
1k 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 ...
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 ...
3
votes
2answers
194 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 ...
1
vote
2answers
148 views

New IT project documentation

When there is a new IT project, what documentation should we begin with? What structure do they usually have. Is there a common standard to compose them? I am entirely new to IT projects, I am ...
0
votes
2answers
109 views

Project Management templates - Official standards across industry

Does anyone know if, according to PMI, or any other PM certification, there are official templates for project management artifacts. I am interested in the following documentation: Project charter ...
2
votes
1answer
33 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. ...
1
vote
1answer
35 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. ...
2
votes
5answers
10k 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
74 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
266 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
107 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
55 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
195 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
111 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 ...
0
votes
2answers
926 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
67 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
848 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
237 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
111 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
226 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
2answers
3k 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
66 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 ...
8
votes
5answers
786 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
105 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
221 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
1k 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
588 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
497 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
88 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 ...
14
votes
8answers
1k 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
136 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
69 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 ...
9
votes
2answers
8k 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
621 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
151 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
1k 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
136 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 ...
3
votes
1answer
142 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, ...