zlei6/ragflow
1
0
Fork 0
mirror of https://github.com/infiniflow/ragflow.git synced 2026-07-14 00:48:26 +08:00
Code Issues Packages Projects Releases Wiki Activity

Feat: Put some wiki templates. (#16617)

Browse Source 
### Summary

Add a few of wiki templates.
This commit is contained in:
Kevin Hu
2026-07-03 20:52:27 +08:00
committed by GitHub
parent 06aa169df7
commit cf634b92b4
10 changed files with 264 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
api/db/init_data/compilation_templates/artifacts.yaml → api/db/init_data/compilation_templates/wiki.yaml
View File

@@ -6,9 +6,9 @@ config:
- Each page must be a proper encyclopedic article, NOT a flat bullet list:
- 1. Opening paragraph (2-4 sentences defining what this is). No heading.
- 2. Sections with H2 headings, each starting with prose before sub-bullets.
- 3. Bold key terms on first use; link them with [[ ]] artifactlinks.
- 3. Bold key terms on first use; link them with [[ ]] wikilinks.
- 4. Examples or implications where the source provides them.
- 5. ## See also section at the end with artifactlinks to highly related pages(less than 12).\n
- 5. ## See also section at the end with wikilinks to highly related pages(less than 12).\n
- Page structure could be as following: (Not provided)
entity:
description: >-

47
api/db/init_data/compilation_templates/wiki/brand.yaml Normal file
View File

@@ -0,0 +1,47 @@
instruction: |
- Each page must be a proper encyclopedic article, NOT a flat bullet list:
- 1. Take prefix ">" or "-" in the "page_example" as instructions to generate the content.
- 2. Sections with H2 headings, each starting with prose before sub-bullets.
page_example: |
# Tone of voice
## Principles
> The tonal principles that shape the way you communicate.
### Principle 1
> Details
### Principle 2
> Details
## Voice
> Qualify what your company public's personality is and is not.
### We are adjective, not adjective
> Details
### We are adjective, not adjective
> Details
## Tone
> Describe your general tone
> Use the matrix below to determine which tonal principles should drive which messaging.
| Channel | Leading tonal principle | Copy examples
| :--- | :---: | ---: |
|Website|Principle|Example
|Advertising|Principle|Example
|Social|Principle|Example
## Stylistic guidance
> Easy rules and tactics everyone can apply about punctuation, lexicon, formatting...
### Tip 1
> Details
### Tip 2
> Details
## Dos & Dont's
|We say 👍| We don't say 🙅|
| :--- | :---: |
|Example| Example|
|Example| Example|
topic: marketing

42
api/db/init_data/compilation_templates/wiki/engineering.yaml Normal file
View File

@@ -0,0 +1,42 @@
instruction: |
- Each page must be a proper encyclopedic article, NOT a flat bullet list:
- 1. Take prefix ">" or "-" in the "page_example" as instructions to generate the content.
- 2. Sections with H2 headings, each starting with prose before sub-bullets.
page_example: |
# Secret feature(Title)
## Background & research
> Explain the context behind why we are doing this project. Data is a great source of insight.
## Problem statement
> As a who, I am trying to outcome/job. But problem/barrier because root cause which makes me feel emotion.
## Goals
- List goals
- KPIs
- What success looks like
## Hypothesis
> If we achieve/enable X, then user behavior Y changes in this way leading to positive metrics Z.
## Technical solution
> Outline the solution step by step and illustrate your points with specific code structure.
```
Fill code snippet
```
## Scope
> Explain the solution is, how it works and the extent of the work involved.
- Requirements
- Future evolutions
- Out of scope
## Designs and assets
> Add any necessary figma project link, hi-fi mockups, SVGs, font files, images, prototypes...
## Open questions
[x] E.g. is this part of the free plan?
topic: engineering

10
api/db/init_data/compilation_templates/wiki/general.yaml Normal file
View File

@@ -0,0 +1,10 @@
topic: general
instruction: |
- Each page must be a proper encyclopedic article, NOT a flat bullet list:
- 1. Opening paragraph (2-4 sentences defining what this is). No heading.
- 2. Sections with H2 headings, each starting with prose before sub-bullets.
- 3. Bold key terms on first use; link them with [[ ]] wikilinks.
- 4. Examples or implications where the source provides them.
- 5. ## See also section at the end with wikilinks to highly related pages(less than 12).\n
page_example: |
- (Not provided)

25
api/db/init_data/compilation_templates/wiki/market.yaml Normal file
View File

@@ -0,0 +1,25 @@
instruction: |
- Each page must be a proper encyclopedic article, NOT a flat bullet list:
- 1. Take prefix ">" or "-" in the "page_example" as instructions to generate the content.
- 2. Sections with H2 headings, each starting with prose before sub-bullets.
page_example: |
# Competitor analysis(title)
## Analysis strengths/weaknesses
> Use the table below to analyze strong and weak points of each competitor
| Competitor Name | Weakness | strengths |
| :--- | :---: | ---: |
| Laptop | Electronics | something |
| Coffee Mug | Kitchenware | something |
| Desk Chair | Furniture | something |
## Positioning & use cases
> How is the product positioning itself on the market? What use cases does it enable?
## Features to note
> List and add screenshots of any noteworthy feature.
## Pricing
topic: marketing

41
api/db/init_data/compilation_templates/wiki/product.yaml Normal file
View File

@@ -0,0 +1,41 @@
instruction: |
- Each page must be a proper encyclopedic article, NOT a flat bullet list:
- 1. Take prefix ">" or "-" in the "page_example" as instructions to generate the content.
- 2. Sections with H2 headings, each starting with prose before sub-bullets.
page_example: |
# Onboarding flow update
## Background & research
summary(example): 40% of new users aren't activating. By reviewing our onboarding flow we'll help teams better understand the value of the product and activate faster on Slite.
## Problem statement
> As a new user, I am trying to get started with the product. But I don't understand the features and the product because nothing is explained to me which makes me feel like I don't know how to use the tool at all.
## Goals
- Increase user activation by 10 points
## Hypothesis
> If we review our onboarding to help users, then we will retain more users leading to positive activation results.
## Vision narrative
We ask users about themselves in order to give them more personalized information to help them get started.
## Scope
1. Decide the questions we ask users
2. Personalize how we cater to each different types of users
3. Plan for the content
4. Build and ship the new flow
## First mock-ups
> maybe some images here.
## Open questions
[x] How will we measure this?
[x] How do Marketing and Product work on this together?
## Technical factoring
> Engineers can estimate the project to plan for code structure and specific technical choices.
```
async fn quick_task() -> Result<&'static str> {
println!("START quick_task");
await!(delay(10)).context("delay failed")?;
println!("END quick_task");
Ok("quick_task result")
```
topic: product

27
api/db/init_data/compilation_templates/wiki/user_interview.yaml Normal file
View File

@@ -0,0 +1,27 @@
instruction: |
- Each page must be a proper encyclopedic article, NOT a flat bullet list:
- 1. Take prefix ">" or "-" in the "page_example" as instructions to generate the content.
- 2. Sections with H2 headings, each starting with prose before sub-bullets.
page_example: |
# User interview
## Takeaways
- The team is still unaware about features x, y, z
- Takeaway 2
- Takeaway 3
## Goal
> What are you trying to find out with this interview?
## Feedback
### Why did you sign up?
> Record user's answer.
### Have you tried other alternatives?
- Competitors
- Process
### Question #3
> Record user's answer.
## Resources
> Upload screenshots or video recordings of your interview. Any relevant file exchanged during your conversation can be added too.
topic: product