File tree 5 files changed +108
-0
lines changed
5 files changed +108
-0
lines changed File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
1
+ ---
2
+ name : Story task
3
+ about : This template is for a story or task, encompassing a single work item for completion
4
+ title : " "
5
+ labels : " documentation"
6
+ projects : ["nginxinc/32"]
7
+ assignees : " "
8
+ ---
9
+
10
+ * Remove italicized directions as relevant to reduce noise in the issue description.*
11
+
12
+ ## Overview
13
+
14
+ * Written as a user story* .
15
+
16
+ ** As a** <user >, ** I want** <thing >, ** So I can** <action >.
17
+
18
+ ## Description
19
+
20
+ * Add the finer details of what this task involves and is trying to accomplish. A problem well defined is half-solved* .
21
+
22
+ ## Acceptance criteria
23
+
24
+ * Add any exacting acceptance criteria for the task to be complete. Start with known hard requirements, since they may create blockers.*
Original file line number Diff line number Diff line change
1
+ ---
2
+ name : Epic overview
3
+ about : This template is for planning an epic, which is a large body of effort involving multiple stories or tasks
4
+ title : " "
5
+ labels : " epic, documentation"
6
+ projects : ["nginxinc/32"]
7
+ assignees : " "
8
+ ---
9
+
10
+ * Remove italicized directions as relevant to reduce noise in the issue description.*
11
+
12
+ ## Description
13
+
14
+ * Write a high-level description of what the body of work for this epic includes.*
15
+
16
+ ## Goals
17
+
18
+ * Describe the intent of the epic and what the intended impact is for this effort.*
19
+
20
+ ## User stories
21
+
22
+ * Add a user story for relevant persona to this epic, who are the stakeholders* .
23
+
24
+ ** As a** <user >,
25
+ ** I want** <thing >,
26
+ ** So I can** <action >.
27
+
28
+ ** As a** <user >,
29
+ ** I want** <thing >,
30
+ ** So I can** <action >.
31
+
32
+ ## Tasks
33
+
34
+ * Create a simple list of tasks necessary for this epic. Finer details should be kept to sub-issues/tasks/stories.*
35
+
36
+ - Example task 1
37
+ - Example task 1
38
+ - Example task 1
39
+ - Example task 1
40
+ - Example task 1
Original file line number Diff line number Diff line change
1
+ ---
2
+ name : Content release plan
3
+ about : This template is for a content release plan, typically tied to a product release
4
+ title : " v#.# content release plan"
5
+ labels : " documentation"
6
+ projects : ["nginxinc/32"]
7
+ assignees : " "
8
+ ---
9
+
10
+ * Remove italicized directions as relevant to reduce noise in the issue description.*
11
+
12
+ ## Overview
13
+
14
+ - ** Product name** :
15
+ - ** Release date** :
16
+
17
+ A content release plan establishes and tracks the documentation work for a product related to a release.
18
+
19
+ Add tickets to this content release plan as sub-issues, and update it as you go along.
20
+
21
+ ## Description
22
+
23
+ * Write a high-level summary of changes expected in this release* .
24
+
25
+ ## User stories
26
+
27
+ ** As a** technical writer,
28
+ ** I want** a content release plan for my product,
29
+ ** So I can** ensure correct content is released alongside the latest version of the product.
30
+
31
+ ** As a** product owner,
32
+ ** I want** a content release plan for my product,
33
+ ** So I can** ensure the product team includes documentation as part of changes to the product.
34
+
35
+ ## Tasks
36
+
37
+ * Create a simple list of tasks necessary for this content plan. Finer details can be kept to sub-issues.*
38
+ * Each task item should have a 1:1 relationship with a documentation item, which could be an engineering issue.*
39
+
40
+ - [ ] Update changelog/release notes
41
+ - [ ] Update version reference information (Such as technical specifications, version shortcodes)
42
+ - [ ] Update any other documentation impacted by changes in this release
43
+ - Additional task 1
44
+ - Additional task 2
You can’t perform that action at this time.
0 commit comments