如何投稿

AI 课堂面向全员开放投稿,欢迎分享你在 AI 协同办公、AI 赋能开发以及 AI 工具使用方面的真实经验。所有稿件经审核后公开发布于 ai-classroom.qubitlab.cc

投稿方式

根据你的技术背景,可以选择以下任一方式参与:

开发者:通过 GitHub 提交 PR

适合熟悉 Git 与 Markdown 的协作者。你只需在 import/ 目录中补充稿件,无需关心站点构建、分类归档等后续步骤——AI 课堂维护者会审查内容,并完成格式整理与正式发布。

基本流程:

  1. Fork 本仓库(或在本仓库创建 feature 分支)
  2. import/<你的目录名>/ 下放置稿件与配图
  3. 提交 Pull Request
  4. 维护者审核通过后,将内容整理至 content/library/ 并部署上线

import/ 目录约定:

import/
└── <你的目录名>/          # 建议用拼音或英文名,如 zhangsan
    ├── readme.md          # 必填,声明作者名称
    └── <文章标题>/        # 每篇稿件一个子目录
        ├── 文章标题.md
        └── images/        # 配图(可选)

readme.md 格式示例:

markdown
作者名称:张三

同一目录下的所有稿件将统一使用该作者名称。稿件正文暂不需要 frontmatter,维护者会在发布时补全元数据。

开发者投稿提示:

  • 一篇文档聚焦一个主题,使用清晰的标题层级
  • 代码示例注明语言与运行环境
  • 截图与配图放在稿件同级 images/ 目录
  • 提交 PR 前自查是否含有敏感信息(见下方「投稿要求」)

非开发者:直接发送文档

如果你不熟悉 Git 或 Markdown,可以将 Word、飞书文档、PDF 等原始资料直接发送给 AI 研究小组。维护者会协助整理格式、补充元数据,并完成审核与发布。

建议随稿提供:

  • 文章标题与一句话摘要
  • 作者姓名或昵称
  • 正文内容(可含截图)
  • 希望归属的分类(工具 / 流程 / Prompt / 案例)

发送前请对照下方「投稿要求」自行检查一遍,可加快审核进度。

投稿要求

AI 课堂内容完全公开,面向团队内外读者。我们欢迎真实、实用的经验分享,并对每篇稿件严格把关。

内容安全与合规

  • 禁止出现公司关键信息、未公开的业务数据、客户资料、内部系统细节等保密内容
  • 禁止包含 API Key、Token、密码、未脱敏的内网地址或数据库连接串
  • 涉及具体项目时,请做脱敏处理(替换为通用描述或虚构名称)
  • 引用外部资料须注明来源,不得侵犯版权

真实性与实用性

  • 内容须基于真实使用经验,步骤可复现、结论有依据
  • 拒绝完全由 Agent 批量生成的「灌水」内容——AI 可以辅助润色与排版,但核心观点、案例与结论应来自作者本人的实践
  • 一篇文档讲透一个主题,避免空洞的概念堆砌或工具清单罗列
  • 语言清晰、结构完整,对读者有实际参考价值

优秀供稿者激励

持续产出高质量内容的供稿者,有机会加入 AI 先驱者组织,享受公司提供的 AI 补贴与人才培养计划。维护者会在审核过程中关注稿件质量,并适时发出邀请。

内容分类

维护者会根据稿件主题归档至以下分类:

分类目录适用内容
AI 工具content/library/tools/Cursor、Copilot、Claude Code 等工具使用技巧
协同流程content/library/workflows/团队协同办公与 AI 赋能开发流程
Prompt 实践content/library/prompts/Prompt 模板、对话策略与最佳实践
案例经验content/library/cases/项目案例、踩坑复盘与效果总结

审核与发布

  1. 内容审查:维护者检查真实性、敏感信息与格式规范
  2. 构建验证:CI 自动运行 npm run docs:build 确保站点可正常构建
  3. 合并发布:审核通过后合并至 main,GitHub Actions 自动部署至线上站点

审核周期通常为 1~3 个工作日。如有疑问,可在 GitHub Issues 中提出,或联系 AI 研究小组。

本地预览(可选)

开发者若想在提交 PR 前预览站点效果,可在本地运行:

bash
npm install
npm run docs:dev

浏览器访问 http://localhost:5173/ 查看效果。非开发者无需执行此步骤。