Skip to content
This repository was archived by the owner on Apr 7, 2026. It is now read-only.

Commit b1f76ee

Browse files
committed
feat: add appendix how-to-ask.md
1 parent 55cd3e9 commit b1f76ee

3 files changed

Lines changed: 27 additions & 1 deletion

File tree

docs/.vitepress/config/zh.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,12 @@ function sidebarGuide(): DefaultTheme.Sidebar {
6060
{ text: 'Lab0', link: '/lab/lab0' },
6161
]
6262
},
63+
{
64+
text: '附录',
65+
items: [
66+
{ text: '提问的艺术', link: '/appendix/how-to-ask' },
67+
]
68+
},
6369
{
6470
text: '团队',
6571
link: '/team'

docs/appendix/how-to-ask.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# 如何正确提问?
2+
3+
1. 在提问开始前,请先自己尝试通过ai或搜索引擎解决问题,不要问诸如“Linux 和 Ubuntu 的区别是什么”等可以通过搜索引擎轻松解决的问题。
4+
2. 当你确认你没法独自解决时,详细描述你遇到的问题,你需要提供的信息包括但不限于:
5+
1. 你想干什么,你希望的结果是什么样子的。(这很重要!)
6+
2. 你使用的系统、编译环境、CPU 型号或厂商。(如果需要的话)
7+
3. 你使用的语言和代码。请不要拍屏或直接在 IDE 里截屏。正确的做法应该是,如果代码较短,使用 [Carbon](carbon.now.sh) 生成图片再发到群里;如果代码较长,请同时附上代码文件,以及标注你认为关键的行数。如果实在不想搞,也请在截图的时候把行号一起截进去,而且,把代码发完整!
8+
4. 详细的报错信息,以及你执行了什么操作能够还原这个报错。不要问“我这份代码大概有 1% 的概率会崩溃,该怎么修改”,而是“这份代码在大多数情况下能正常运行,但是在我执行了 xxx 操作,然后再执行 xxx 操作的时候会崩溃”。
9+
5. 你认为这个问题可能是怎么导致的,你认为可能有哪些方向可能能解决这个问题。(这很重要!)
10+
3. 警惕“XY Problem”,你不应该在提问时过多代入自己的思考。比如,计算两数相除的循环节问题,提问者可能会想,好像书上看到过对计算精度要求高的时候应该使用高精度算法,我先导入一个gmp库,然后提问“如何使用高精度运算库gmp来计算两数相除的循环节”,这是错误的。你应该直接提问“如何计算两数相除的循环节”。
11+
4. 使用良好的代码风格,使用有意义的变量名(而不是 abcd)。没有人喜欢阅读 `cout<<(a+=scanf("%d",&c+i)!=0<<'\n');` 这样的代码。你可以参照 [谷歌代码规范](https://zh-google-styleguide.readthedocs.io/en/latest/google-cpp-styleguide/) 来修改你的代码,或者使用代码格式化工具。

package.json

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,16 @@
88
"docs:serve": "vitepress serve docs",
99
"docs:preview": "vitepress preview docs"
1010
},
11-
"author": "",
11+
"author": "Zecyel <i@zecyel.xyz>",
12+
"maintainers": [
13+
{ "name": "Zecyel", "url": "https://github.com/Zecyel" },
14+
{ "name": "fduTristin", "url": "https://github.com/fduTristin" },
15+
{ "name": "Caibao7", "url": "https://github.com/Caibao7" },
16+
{ "name": "JurFal", "url": "https://github.com/JurFal" },
17+
{ "name": "ranxiaoxiao-mmm", "url": "https://github.com/ranxiaoxiao-mmm" },
18+
{ "name": "xzh2004", "url": "https://github.com/xzh2004" },
19+
{ "name": "ell77abu", "url": "https://github.com/ell77abu" }
20+
],
1221
"dependencies": {
1322
"@nolebase/vitepress-plugin-enhanced-mark": "^2.12.0",
1423
"@nolebase/vitepress-plugin-enhanced-readabilities": "^2.11.1",

0 commit comments

Comments
 (0)