Questions tagged [documentation]
The documentation tag is for questions about documentation of processes and projects in the field of project management.
117
questions
1
vote
4
answers
159
views
What are the alternatives to using user stories for documenting system features?
We are an inventory management system product company. We used, and still use, agile user stories for writing requirements and communicating them to the development team. During the initial stages we ...
- 11
0
votes
1
answer
48
views
What is the name of the practice of mapping problems and their inter connected relationships?
Some time ago I saw an article about a model where the different problems or dysfunctions of a team (or company) where identified.
Then, once the problems are identified, the relationship between them ...
- 8,615
0
votes
4
answers
104
views
What is the document that must be provided by a client before contracting?
We are a startup company where we work on software projects. To effectively manage our client's projects, I wonder what document we must ask the client to provide us before we both sign the contract. ...
1
vote
2
answers
154
views
How do you get multiple separate software development teams to unify their best practices? [closed]
We have several reasonably well functioning small software development teams working on different areas of the business. Each team has its own lead and roughly 8 other developers on it. The teams have ...
- 11
2
votes
3
answers
85
views
What is the usual process of summarizing the specification documents for review and comparision
My engineering team is gearing up for a bidding on a public project, where the specifications document is huge (~500 pages). I would like to break it down clause by clause in a spreadsheet and then ...
1
vote
3
answers
111
views
Does the client have the privilege to force the vendor on a Business Requirement Document (BRD) format?
Would like to ask:
Does the client project manager have the privilege to force the vendor who is selling a SaaS system to use some specific Business Requirement Document (BRD) format and force them to ...
4
votes
5
answers
292
views
How to approach this: A team member with Good technical skills but weak in other areas
My team consists of 7 people and I am the project manager. A teammate of mine has good technical skills, but he struggles with documenting the results of his work and delivering documents to the next ...
- 143
0
votes
1
answer
40
views
Project management with MS Teams and MS Sharepoint in a large enterprise
Before the MS Teams "era", documents for (larger) projects existed as folder structures on huge storages as "master system for documentation".
Today, you have got many Sharepoint ...
- 291
0
votes
2
answers
70
views
Example layouts / standards for filesystem folder names in project documentation?
I am new to project management and would like to know, where is a standard either a best practice to define name of project folder tree in the filesystem, or SharePoint.
Maybe there is something ...
- 291
0
votes
1
answer
86
views
ISO 9001: a company does not store the customer contracts properly. What ISO requirement is being violated?
As a part of my quality improvement activities, I wanted to fix some of the issues in our company (like contracts not being stored properly). I thought there will be a clear requirement/clause in ISO ...
- 363
1
vote
1
answer
77
views
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 ...
0
votes
1
answer
79
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 ...
- 131
1
vote
2
answers
114
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 ...
- 11
1
vote
2
answers
261
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 ...
- 363
2
votes
1
answer
85
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 ...
- 303
1
vote
4
answers
75
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 ...
- 11
-1
votes
2
answers
2k
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 ...
0
votes
2
answers
2k
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
1
answer
122
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-...
- 121
0
votes
2
answers
90
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 ...
- 1
-4
votes
1
answer
180
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 ...
- 101
1
vote
1
answer
405
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 ...
- 111
3
votes
5
answers
2k
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 ...
- 191
11
votes
5
answers
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 ...
- 187
3
votes
2
answers
243
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 ...
- 31
1
vote
2
answers
159
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 ...
- 383
0
votes
2
answers
167
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
1
answer
34
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.
...
- 21
1
vote
1
answer
42
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.
...
- 119
2
votes
5
answers
13k
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 ...
- 121
4
votes
1
answer
87
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 ...
- 141
1
vote
2
answers
637
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 ...
- 155
0
votes
2
answers
111
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 ...
- 129
0
votes
1
answer
58
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 ...
- 101
-2
votes
3
answers
245
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....
- 105
0
votes
3
answers
132
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 ...
- 11
0
votes
2
answers
1k
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 ...
- 476
0
votes
1
answer
80
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 ...
- 379
2
votes
1
answer
1k
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 ...
- 935
-4
votes
3
answers
417
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 ...
- 253
3
votes
1
answer
117
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 ...
- 131
6
votes
6
answers
286
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 ...
- 323
6
votes
2
answers
4k
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 ...
- 163
0
votes
2
answers
76
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
8
votes
5
answers
1k
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 ...
- 219
-3
votes
2
answers
110
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 ...
- 97
3
votes
1
answer
316
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 ...
- 31
0
votes
3
answers
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 ...
- 1,141
0
votes
1
answer
665
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
3
votes
4
answers
2k
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 ...
- 181