Skip to content

Commit d3135e2

Browse files
debidongdebidong
authored
docs: add post-mortem feature documentation (#23)
* docs: add post-mortem feature documentation (zh + en) Add 4 bilingual documentation pages for the new post-mortem feature: - What is a Post-Mortem (overview, concepts, workflow) - Create and Edit Post-Mortem Reports (creation, collaboration, publishing) - AI-Assisted Post-Mortem Generation (usage, data sources, tips) - Manage Post-Mortem Templates (built-in, custom, permissions) Update docs.json navigation with Post-Mortem group under On-call tab for both zh and en languages. * fix: rename Pro to Professional in English post-mortem docs
1 parent 32f48e3 commit d3135e2

9 files changed

Lines changed: 684 additions & 0 deletions

‎docs.json‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,15 @@
104104
"zh/on-call/incident/outlier-incidents"
105105
]
106106
},
107+
{
108+
"group": "故障复盘",
109+
"pages": [
110+
"zh/on-call/post-mortem/what-is-post-mortem",
111+
"zh/on-call/post-mortem/create-edit-post-mortem",
112+
"zh/on-call/post-mortem/ai-generate-post-mortem",
113+
"zh/on-call/post-mortem/manage-templates"
114+
]
115+
},
107116
{
108117
"group": "状态页",
109118
"pages": [
@@ -509,6 +518,15 @@
509518
"en/on-call/incident/outlier-incidents"
510519
]
511520
},
521+
{
522+
"group": "Post-Mortem",
523+
"pages": [
524+
"en/on-call/post-mortem/what-is-post-mortem",
525+
"en/on-call/post-mortem/create-edit-post-mortem",
526+
"en/on-call/post-mortem/ai-generate-post-mortem",
527+
"en/on-call/post-mortem/manage-templates"
528+
]
529+
},
512530
{
513531
"group": "Status Page",
514532
"pages": [

‎en/on-call/post-mortem/ai-generate-post-mortem.mdx‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
---
2+
title: "AI-Assisted Post-Mortem Generation"
3+
description: "Let AI generate a post-mortem report draft based on your incident data, dramatically reducing the manual effort of writing from scratch."
4+
keywords: ["AI generation", "smart post-mortem", "auto-generate", "incident analysis", "AI-assisted"]
5+
---
6+
7+
## Let AI Write the First Draft
8+
9+
The hardest part of writing a post-mortem is often getting started — staring at a blank page, unsure where to begin.
10+
11+
Flashduty's AI-assisted generation can help you get past that. It analyzes all the context around the linked incident and, following the template's section structure, produces a complete first draft. All you need to do is adjust the wording, fill in details, and add your team's conclusions.
12+
13+
<Note>
14+
The post-mortem feature is available on the Professional plan only.
15+
</Note>
16+
17+
## How to Use
18+
19+
<Steps>
20+
<Step title="Create a Post-Mortem Report">
21+
Create a post-mortem report. AI will begin generating content and display it in the editor in real time.
22+
</Step>
23+
24+
<Step title="Refine the Draft">
25+
Once generation is complete, you can edit, trim, or add to the content directly in the editor. Other team members can join and edit simultaneously.
26+
</Step>
27+
</Steps>
28+
29+
## What Data Does AI Use
30+
31+
AI doesn't write in a vacuum — it analyzes the following data to generate the report:
32+
33+
| Data Source | Description |
34+
| :--- | :--- |
35+
| Template structure | Organizes content according to the sections in your chosen template |
36+
| Incident details | Labels, custom fields, severity, responders, and more |
37+
| Response timeline | Actions taken and status changes during incident handling |
38+
| War room chat logs | Discussion content from Feishu or Slack war rooms related to the incident |
39+
40+
<Note>
41+
To provide the AI with complete incident lifecycle context for generating post-mortem reports, your IM war room integration requires additional permissions to read war room chat logs.
42+
43+
1. Feishu integration requires the `im:message.group_msg` scope.
44+
2. Slack integration requires the `channels:history` scope.
45+
46+
Please update your app permissions or reauthorize. Refer to the integration documentation for details. Due to platform API limitations, WeCom and Dingtalk do not currently support war room chat log extraction.
47+
</Note>
48+
49+
## Usage Limits
50+
51+
To ensure service quality, AI generation has the following limits:
52+
53+
| Constraint | Details |
54+
| :--- | :--- |
55+
| Generation frequency | Up to 5 times per minute per account |
56+
| Concurrency | Only 1 generation task per report at a time |
57+
58+
If you see a rate limit message, wait a moment and try again. If a message indicates someone else is generating, wait for them to finish.
59+
60+
## Tips for Better AI Output
61+
62+
- **Pick the right template**: AI strictly follows the template's section structure. A well-organized template leads to a well-organized report.
63+
- **Enrich your incident context**: Labels, custom fields, and the response timeline are the primary inputs for AI analysis. The more complete they are, the deeper the generated report will be.
64+
- **Leverage your IM integration**: If your team discussed root causes and remediation in a Feishu or Slack war room, those conversations will be factored into the AI's analysis for a more accurate report.
65+
- **Treat AI as a starting point, not the finish line**: The AI draft is a great foundation, but the final report should include your team's in-depth discussion, genuine root cause consensus, and actionable improvement plans.
66+
67+
## Time Display
68+
69+
Time information in the post-mortem report automatically adapts to your timezone settings, ensuring team members in different regions see accurate local times.

‎en/on-call/post-mortem/create-edit-post-mortem.mdx‎

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
---
2+
title: "Create and Edit Post-Mortem Reports"
3+
description: "Learn how to create a post-mortem report from an incident, collaborate with your team using the online editor, and publish and manage reports."
4+
keywords: ["create post-mortem", "edit post-mortem", "collaborative editing", "publish post-mortem", "delete post-mortem", "image upload"]
5+
---
6+
7+
## Create a Post-Mortem Report
8+
9+
Once an incident has been closed, you can begin the post-mortem process.
10+
11+
<Steps>
12+
<Step title="Select an Incident">
13+
From the incident list or incident detail page, select the incident you want to review.
14+
</Step>
15+
16+
<Step title="Choose a Template">
17+
Pick a post-mortem template to define the report's section structure. The system provides built-in templates in Chinese and English, or you can choose a custom template created by your team.
18+
</Step>
19+
20+
<Step title="Create with One Click">
21+
Click "Create Post-Mortem Report" and the system will automatically extract severity, response time, responders, and other key information from the incident, generate a draft report, and take you to the editor.
22+
</Step>
23+
</Steps>
24+
25+
<Note>
26+
Currently, each incident can only have one post-mortem report. If the incident already has a report, the system will open the existing one.
27+
</Note>
28+
29+
## Online Collaborative Editing
30+
31+
Once you open the report, you'll enter an online collaborative editor. If you've used Google Docs, Notion, or Feishu Docs before, this will feel very familiar — multiple team members can edit the same report simultaneously, with all changes visible in real time.
32+
33+
The editor auto-saves your work, so there's no need to manually click save.
34+
35+
### Inserting Images
36+
37+
While editing, you can paste or drag images directly into the editor — monitoring dashboard screenshots, architecture diagrams, or any other key visuals.
38+
39+
| Constraint | Details |
40+
| :--- | :--- |
41+
| Supported formats | JPEG, PNG, WebP, GIF |
42+
| Max size per image | 4 MB |
43+
| Max images per report | 100 |
44+
45+
## Refining Report Details
46+
47+
Beyond the report body, there are a few other important fields to pay attention to:
48+
49+
### Title
50+
51+
The system auto-generates a default title based on the linked incident's title. You can edit it directly at the top of the editor to something more precise, such as "2026-03-15 Payment Service Timeout Causing Order Failures". The maximum title length is 256 characters.
52+
53+
### Key Metrics
54+
55+
The key metrics panel shows the critical indicators for this incident. You can adjust them based on the actual situation:
56+
57+
| Field | Description |
58+
| :--- | :--- |
59+
| Highest severity | The peak severity level of this incident |
60+
| Earliest start time | When the incident was first triggered |
61+
| Latest close time | When the incident was last closed |
62+
| Total duration | The combined duration of all linked incidents |
63+
| Responders | People who participated in handling the incident |
64+
65+
### Follow-Up Items
66+
67+
Follow-up items are for recording action items that come out of the review — things like "optimize database connection pool settings" or "add cache circuit breaker". Follow-ups can be edited at any time, whether the report is in draft or published status.
68+
69+
## Publishing and Managing
70+
71+
### Publish a Report
72+
73+
Once the team has confirmed the content, click the "Publish" button to switch the report from draft to published.
74+
75+
<Tip>
76+
Publishing isn't the end of the road. If new findings emerge or corrections are needed later, just switch back to draft, make your changes, and republish.
77+
</Tip>
78+
79+
### Finding Reports
80+
81+
In the post-mortem report list, you can filter by status, team, channel, and creation date range, with sorting by creation time or last updated time.
82+
83+
### Deleting a Report
84+
85+
If a report is truly no longer needed, you can delete it from the report detail page.
86+
87+
<Warning>
88+
Deletion is irreversible. Please proceed with caution.
89+
</Warning>

‎en/on-call/post-mortem/manage-templates.mdx‎

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
---
2+
title: "Manage Post-Mortem Templates"
3+
description: "Use templates to standardize your team's post-mortem process and ensure every review covers the key information."
4+
keywords: ["post-mortem template", "template management", "custom template", "built-in template", "template editing"]
5+
---
6+
7+
## Why Templates
8+
9+
Having to think from scratch about "what should we cover" every time you write a post-mortem is both time-consuming and error-prone. Templates solve this by defining sections and guidelines upfront, so every report follows a consistent structure — and giving AI a clear framework to generate content from.
10+
11+
<Note>
12+
The post-mortem feature is available on the Professional plan only.
13+
</Note>
14+
15+
## Built-In Templates
16+
17+
The system comes with two ready-to-use built-in templates:
18+
19+
| Template | Language | Sections |
20+
| :--- | :--- | :--- |
21+
| 默认故障复盘报告模板 | Chinese | Summary, Root Cause, Impact, Timeline, Corrective Actions, Lessons Learned |
22+
| Default Post Mortem Report Template | English | Summary, Root Cause, Impact, Timeline, Corrective Actions, Lessons Learned |
23+
24+
These two templates cover the most common sections in a post-mortem and work well for most scenarios. If your team has specific needs, you can create custom templates based on these.
25+
26+
<Note>
27+
Built-in templates cannot be modified or deleted.
28+
</Note>
29+
30+
### What Each Section Is For
31+
32+
| Section | What Question Does It Answer |
33+
| :--- | :--- |
34+
| **Summary** | What happened? A few sentences to give anyone not involved a quick overview |
35+
| **Root Cause** | Why did it happen? What were the direct and underlying causes |
36+
| **Impact** | How many users were affected, which services, and for how long |
37+
| **Timeline** | From detection to recovery — what was done and when |
38+
| **Corrective Actions** | What will be done next to prevent similar issues |
39+
| **Lessons Learned** | What did the team take away from this experience |
40+
41+
## Creating Custom Templates
42+
43+
If the built-in templates don't fully meet your needs — say your team wants to add a "Customer Communication Log" or "Cost Impact Assessment" section — you can create custom templates.
44+
45+
<Steps>
46+
<Step title="Go to Template Management">
47+
On the post-mortem report page, click "Template Management".
48+
</Step>
49+
50+
<Step title="Fill in Basic Information">
51+
52+
| Field | Required | Description |
53+
| :--- | :---: | :--- |
54+
| Template name | Yes | Give it a clear name, such as "Payment Team Post-Mortem Template" |
55+
| Template description | No | Briefly describe what scenarios this template is for |
56+
| Owning team | Yes | Select the team responsible for maintaining this template |
57+
| Template content | Yes | Define the section structure in the editor |
58+
</Step>
59+
60+
<Step title="Design the Section Structure">
61+
Define your template sections in the editor. We recommend using H2 headings for section titles and adding a quote block under each one as a writing guide to tell authors what that section should cover.
62+
</Step>
63+
64+
<Step title="Save">
65+
Click "Save" to finish. The new template will immediately appear in the template list and be available for all users when creating post-mortem reports.
66+
</Step>
67+
</Steps>
68+
69+
<Tip>
70+
The template's section structure also serves as the framework for AI-generated content, so clear section definitions don't just help people write better — they also make the AI's output more targeted.
71+
</Tip>
72+
73+
## Editing and Deleting Templates
74+
75+
Click any custom template in the template list to edit its name, description, owning team, or content. Templates that are no longer needed can be deleted.
76+
77+
<Tip>
78+
Deleting a template does not affect any post-mortem reports that were already created using it.
79+
</Tip>
80+
81+
## Who Can Manage Templates
82+
83+
Anyone can create a template, but editing and deleting are controlled by team ownership:
84+
85+
| Role | Edit and Delete |
86+
| :--- | :--- |
87+
| Account-level user / Account admin | Can manage all templates |
88+
| Members of the template's owning team | Can manage their team's templates |
89+
| Other users | Can view and use only, cannot edit or delete |
90+
91+
<Tip>
92+
While editing and deleting have permission restrictions, all users can choose any template when creating a post-mortem report — including custom templates created by other teams.
93+
</Tip>

‎en/on-call/post-mortem/what-is-post-mortem.mdx‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
title: "What is a Post-Mortem"
3+
description: "A post-mortem is a systematic review and analysis conducted after an incident has been resolved, helping teams learn from what happened and prevent similar issues from recurring."
4+
keywords: ["post-mortem", "incident review", "post-incident analysis", "post-mortem report", "continuous improvement"]
5+
---
6+
7+
## Why Post-Mortems Matter
8+
9+
After an incident is resolved, does your team breathe a sigh of relief and move on?
10+
11+
If you don't take the time to review and reflect, the same issues are likely to resurface in a different form. A post-mortem is about helping your team step back after the dust settles and systematically answer three questions: **What happened, why it happened, and how to prevent it from happening again.**
12+
13+
Flashduty integrates post-mortems directly into your incident management workflow — create a report from the incident detail page with one click, let AI draft the initial content, collaborate with your team to refine it, and produce an archivable, traceable post-mortem report.
14+
15+
<Note>
16+
The post-mortem feature is available on the Professional plan only.
17+
</Note>
18+
19+
## What Does a Post-Mortem Report Look Like
20+
21+
A typical post-mortem report contains:
22+
23+
- **Linked incident**: Which incident this report is written for
24+
- **Key metrics**: Severity, incident time range, duration, and responders
25+
- **Report body**: A detailed analysis organized by template sections — typically including summary, root cause analysis, impact, timeline, corrective actions, and lessons learned
26+
- **Follow-up items**: Action items that need to be carried out after the review
27+
- **Author list**: Everyone who contributed to writing the report
28+
29+
### Report Status
30+
31+
A post-mortem report has two statuses:
32+
33+
| Status | Meaning |
34+
| :--- | :--- |
35+
| **Draft** | The report is still being written and can be freely edited |
36+
| **Published** | The report is finalized and available for the team to review |
37+
38+
<Tip>
39+
You can switch between draft and published at any time. If you need to add something after publishing, simply switch back to draft, make your changes, and republish.
40+
</Tip>
41+
42+
### Ownership
43+
44+
When a post-mortem report is created, it automatically inherits the channel and team from the linked incident, making it easy to manage and browse reports by team.
45+
46+
## What Makes Flashduty Post-Mortems Different
47+
48+
### AI Writes the First Draft
49+
50+
No more staring at a blank page. Click **Generate Post-Mortem Report**, and the system will analyze the incident's alert data, response timeline, and even war room discussions to produce a complete first draft. All you need to do is refine and supplement it.
51+
52+
### Collaborate Like an Online Document
53+
54+
Multiple team members can open and edit the same report simultaneously — changes are visible in real time with no conflicts.
55+
56+
### Standardize with Templates
57+
58+
The system provides built-in templates in both Chinese and English, and you can create custom templates tailored to your team. Consistent templates ensure that no critical section is missed in any post-mortem.
59+
60+
### Rich Media Support
61+
62+
The editor supports pasting or dragging images directly, making it easy to include monitoring screenshots, architecture diagrams, or other key visuals in your report.
63+
64+
## A Complete Post-Mortem Workflow
65+
66+
<Steps>
67+
<Step title="Create a Report from an Incident">
68+
From the incident detail page, select the incident and a template, then create a post-mortem report with one click. The system automatically extracts key information from the incident as the report's baseline data.
69+
</Step>
70+
71+
<Step title="Write the Report">
72+
Use the online editor to write the report body — let AI generate the first draft, then collaborate with your team to refine it. You can also edit the title, key metrics, and follow-up items.
73+
</Step>
74+
75+
<Step title="Publish">
76+
Once the content is confirmed, click publish.
77+
</Step>
78+
79+
<Step title="Ongoing Follow-Up">
80+
If you need to add or correct information after publishing, you can switch back to draft at any time. Reports that are no longer needed can be deleted, and the system will automatically clean up all associated data.
81+
</Step>
82+
</Steps>

0 commit comments

Comments
 (0)