Skip to content

Commit

Permalink
REPEAT: Feedback on Essay (#1549)
Browse files Browse the repository at this point in the history
* Feedback proposal for #1080

* Update feedback proposal

* Add proposal for executable tutorial

* Update README for submission

* Improved feedback

* Small fix

Co-authored-by: kittyt <kittyt@kth.se>
  • Loading branch information
elmaxe and kittytinythai authored Jun 1, 2021
1 parent 0d08f78 commit 23104a1
Show file tree
Hide file tree
Showing 2 changed files with 100 additions and 19 deletions.
117 changes: 99 additions & 18 deletions contributions/feedback/kittyt-axelelm/AxelFeedback.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,110 @@
My feedback
# Feedback on essay "Agile project management with Jira"
# REPEAT: Feedback on essay "Agile project management with Jira"

Essay written by: Fredrik Björkman, Adam Henriksson
Feedback provided by: [Axel Elmarsson](https://github.com/elmaxe) (<axelelm@kth.se>)
## Overall
Good grammar, good spelling and good structure of the essay. For the front page I would consider capitalizing every word of the essay, since we are writing an essay in English ("Agile Project Management with Jira" instead of "Agile project management with Jira"). A minor detail: this probably differs from person to person and what kind of essay it is, but front pages don't always have a page numbers, do they?
Figures should be referred to [[1]](https://guides.lib.monash.edu/citing-referencing/apa-tables-figures), otherwise there is no meaning in having them. You are currently only referring to figure 1 and 2. The rest (3, 4, 5, 6) you need to refer to or remove completely.
Nice conclusion in the end! Didn't look too much at your sources, but they look credible, nice that you had many.
I will now give feedback session by session.

## Summary
I think the essay is good. Some things can be improved, see below. I think the content of the essay is interesting. What I am perhaps missing is some negative aspects of Jira, currently the essay talks a lot about positive aspects (which is not strange), but perhaps another view somewhere could be good. Something else that could be interseting is a comparison of Jira and other agile project management tools. Perhaps you could also talk about how and if you can integrate Jira with other software (CI and CD pipelines, Slack etc.).

## Strengths and weaknesses

**Strengths:**
- The topic of the essay is relevant to the course
- The background is great! It gives a great view from traditional engineering models (waterfall) to agile methods.
- Relevant figures
- Good grammar and structure. The essay is structured clearly!

**Weaknesses:**
- As mentioned above, the topic is relevant if you know your DevOps. However, it would be good if you added one or two sentences about why it is relevant for DevOps.
- All figures in an article should be referred to, you are not referring to all your figures.
- Grammar/structure needs fixing in a few places
- Throughout the essay, you use both paragraph spacing combined with paragraph indentation.

## Actionable improvements
- Figures should be referred to, otherwise there is no meaning in having them. You are currently only referring to figure 1 and 2. The rest (3, 4, 5, 6) you need to refer to somewhere in the text or remove completely.
- Title: For the front page I would consider capitalizing every word of the essay, since we are writing an essay in English ("Agile Project Management with Jira" instead of "Agile project management with Jira")
- Use either line indentation OR line spacing, not both at the same time. It looks very strange to combine the two.

## Pointers
- Figures should be referred to [[1]](https://guides.lib.monash.edu/citing-referencing/apa-tables-figures).


# Additional actionable improvements
Section by section
## 1 Introduction
"We will not go into how to set up..." -> "we will not go into detail about how to set up..." is better phrasing I think.
Other than that I have nothing to point out.
**Suggestion #1**
Add these words:
> We will not go into **details about** how to set up and use specific features of Jira, ...
This is better phrasing.

## 2 Background

**Suggestion #2**
Perhaps you should refer to Figure 1 earlier in the text. Currently you are referring to it after you have talked about agile methods (end of page 3). I think it would be better to refer to figure 1 in the end of the first paragraph, and only refer to figure 2 in the end of the third paragraph.
Nice figures, good figure texts, as mentioned earlier, good that you refer to these figures.
Content is good.

**Suggestion #3**
Change from
> In modern software development where radical changes in the customer requirements may occur frequently, new innovative ideas may arise from competitors or other unexpected events may happen that need to be addressed, a need for flexibility and the ability to react quickly is essential for the development process.
to

> In modern software development where radical changes in the customer requirements may occur frequently, **new innovative ideas or other unexpected events may happen that need addressing. A** need for flexibility and the ability to react quickly is essential for the development process.
I think this sentence was too long

**Suggestion #4**
> Advantages that comes with a more iterative development strategy is that one can have continuous releases, which allows the customers to be more included in the development process and ~~will be able~~ **allows them** to give feedback based on the current deployment [3].
I think the use of `will` here sounds very strange.

**Suggestion #5**
> With short iterations and where all the team members in a team working **towards** the same goal
According to [[2]](https://www.grammarly.com/blog/toward-towards/), `towards` is the British way of saying `toward`. I suggest you change to `toward` since your essay is not written in British English.

## 3 The project management tool Jira
**Suggestion #6**
> In this chapter the project management tool Jira will be introduced and discussed ~~and~~ **as well as** the advantages of using a project management tool for agile project management.
Too many `and`. The last bi-sentence was not grammatically correct (`discussed` was not applied on it)

## 3.1 What is Jira
Perhaps you should add: "That question we will answer in the following question" or something in those lines after the last question in this section.
I feel like this section could be changed a bit. It doesn't need to be its own section, it could be integrated into the chapter meta text just above.

**Suggestion #7**
Move the second paragraph of `3.1` to `3`. Change `3.1` to only contain the paragraph about what Jira is (first paragraph of `3.1`). Remove the third paragraph of `3.1`, it could be placed in the beginning of section `3.2`. In other words, I'd say you should do like this:

> **3 The project management tool Jira**
In this chapter the project management tool Jira will be introduced and discussed and the advantages of using a project management tool for agile project
management. First **,** the features that help individual developers and small teams to organize their work and optimize their time will be shown. After that, the features that
help managers plan and organize important milestones, get actionable data,
achieve long-term goals, beat the competition and deliver value to customers
will be discussed.
**3.1 What is Jira?**
Jira is a project management tool developed by Atlassian and was originally
developed as a bug and issue tracker, but has today grown to be a powerful
management tool [11].

Why? The second paragraph of `3.1` is a meta text about the chapter, which should go under `3`.

## 3.2 Organize tasks, introducing Kanban
Nothing to say about this section, looks good!

**Suggestion #8**
You are talking about problems in plural, not singular.
> If you cannot see what problems exist, it’s hard to fix ~~it~~ **them**.
## 3.3 Roadmaps
Change from "and the amount of sprints you have to achieve that goal" to "and the amount of sprints you NEED TO have to achieve...", alternatively "the amount of sprints you have to achieve that goal in", I think something is missing in that sentence.
**Suggestion #9**
> Knowing the overall goals of an ~~epic, and~~ **epic as well as** the amount of sprints you **need to** have to achieve that goal helps teams know both if they can finish their planned work on time, ...
## 3.4 Knowledge management with Confluence

I think you shouldn't write "our product" and "we need to follow". I would prefer "What are the formal requirements of the product and the regulations that needs to be followed". The former is more personal, like you're talking about a product you have, but these are instructions for any project. In the following points for example, you are doing it correctly: You are not writing "what did our team do well..." for example.

## 4 Conclusion
I think it is a good conclusion, it sums up what you have talked about in the essay in a nice way.
# Summary
I haven't heard about Jira before so it was nice to get to see a nice agile work tool you can use. The essay's content is good, the structure follows the typical essay format. Great job (:
If you have any questions, feel free to ask!

I think the content of the conclusion is good, it sums up what you have talked about in the essay, which makes the readers take remember more what they have just read. However the conclusion could perhaps be shortened down a bit.

# Final words
I think the essay describes agile methods very well. The authors talk about iterative development and sprints, team and task management, roadmaps and knowledge management. I don't have much negative to say about the content of the essay.
2 changes: 1 addition & 1 deletion contributions/feedback/kittyt-axelelm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ Axel Elmarsson (axelelm@kth.se)
Github: [elmaxe](https://github.com/elmaxe)

## Essay to give feedback on
We have given separate feedback on the essay *How to use Jira for agile project managment*, [#1167](https://github.com/KTH/devops-course/pull/1167). The feedback can be found in PR [#1361](https://github.com/KTH/devops-course/pull/1167) as comments or in `KittyFeedback.md` and `AxelFeedback.md`.
We have given separate feedback on the essay *How to use Jira for agile project managment*, [#1167](https://github.com/KTH/devops-course/pull/1167). The feedback can be found in PR [#1361](https://github.com/KTH/devops-course/pull/1167) as comments or in `KittyFeedback.md` and `AxelFeedback.md`.

0 comments on commit 23104a1

Please sign in to comment.