How is good documentation done using SCRUM?

5

I'm developing documentation using the agile method SCRUM , I do not know if I'm on the right track, and many people have difficulty with it, so I decided to ask this question, >

  • Introduction : summary of what the system will be.
  • R. Product Backlog : list everything the system should do.
  • R. Nonfunctional : what the system must have to work. Example: PHP version, database, framework.
  • First Sprint :

In this sprint I put what requirement it will meet, in addition to the planning of the table made with activity diagrams and classes.

These were the topics I put so far, doing the second sprint only when I finish the first one (because it's just me in the project).

The question is, what points should a documentation using SCRUM have? The main topics to be exposed and how to expose.

P.S: In case of diagrams, should it have class diagrams of automated tests?

    
asked by anonymous 30.12.2016 / 01:51

2 answers

7

Hello, Ivcs!

I will try to answer the question "How is good documentation done using SCRUM?" answering something more generic like "How is agile documentation?", okay? I'll try to be very informal and speak very simple ...

First, it is a myth to say that agile models of development completely abandon documentation. They only rationalize the creation of documents in the sense of doing things REALLY.

Another detail is the difference that is made in agile model is between document and model (diagrams). A document has several templates, but one should not necessarily create a model for documenting, since you can create a model just to reason or make it easier to explain something very specific.

You do not create a class diagram just like you did just to put it in the document, you will create it when you need to explain something to someone on the team or even just to think about relationships. What's more, this modeling does not even have to be a heavyweight process, full of the use of state-of-the-art CASE tools, a simpler tool (or even paper drawing = D) can be used.

Realize that in classic models everything revolves around documentation (key part in these models), even if you create models just to document and document yourself just for mere formalism. In agile methodology the document loses importance (but it is not abandoned !!) and you have a thought called "agile modeling", where you do not model to document, but model because you really need it for a very specific purpose.

No document is created for agile development. You create a document ...

  • Why the customer requested
  • To define a contract template (more detailed documentation is required in these cases)
  • Support communication with an external group
  • Reasoning

An agile document:

  • Maximize customer return
  • Thin and economical
  • Has a specific purpose
  • Describes information that is less likely to change
  • Contains only "good things to know"
  • You have a specific customer and make this customer's work easier
  • Is accurate, consistent, and detailed enough
  • Sufficiently indexed
30.12.2016 / 18:58
3

As an agile methodology, Scrum starts from the presumption that the team is pro-efficient, that is, it can produce maximum value with the minimum of artifact when speaking in documentation. This creates confidence and consequently generates results.

Being agile and constantly evolving a project within Scrum can not have extensive and complex documentation, even because this goes against the pillars of Scrum: Transparency - > Inspection - > Adaptation.

The documentation used in a Scrum project typically consists of:

  • User story
  • Requirements
  • Diagrams

In short, it is leaner documentation with the client language and more objective.

Note: It is important to remember that the "Product Owner" will always be present during the project to clarify any doubts the team has about the documentation.

    
26.05.2017 / 20:04