跳到主要内容
系列文档 · 第 310 min

第 3 集 - 写一篇私人文章

正文

将第 1 集选定的结果整理成一篇私人文章。目标不是完美文笔,而是一页可以审阅的有效内容:把变化、证据和不确定性说清楚。

创建文章、按需添加语言文件、校验内容源,并检查系统实际解析到的内容。

一、创建文章

silan blog new new-research-result

命令会创建:

content/resources/blog/new-research-result/
parts/body/meta.toml
parts/body/en.md

需要中文时:

silan blog add-lang new-research-result zh

新文章会保持私人。创建、编辑、校验或建立索引都不会让它自动公开。

二、先写四件事

打开:

content/resources/blog/new-research-result/parts/body/en.md

把示例正文换成一个小而完整的版本:

## 用一句话说清当前结果

说明改变了什么,以及为什么另一名研究者应该关心。

### 证据

- 主要来源:<论文、数据、benchmark、release、档案或仓库>
- 它支持什么:<准确表述>
- 它不支持什么:<不确定性边界>

### 接下来会改变什么

列出审阅后可能需要更新的项目页、简历表述或旧解释。

不要先写完整项目历史。读者应该在前两句就明白新信息和它的价值。

三、校验系统真正读到了什么

silan content lint silan index sync silan blog show new-research-result

这三个动作分别是:

  • lint 检查内容是否有效;
  • sync 重建本地索引;
  • show 打印系统实际解析到的文章。

继续之前先修复致命问题。与这次更新无关的非致命缺失可以暂时保留。

四、把来路写具体

第一次更新只需要在“证据”部分写清论文、版本、数据集、档案或仓库,并准确说明它支持哪一项判断。

公开发布的 v1.0 版本使用较早的 ideaupdate 内容类型。当前 silan.tech 截图可能显示 update 已更名为 moment,但这个名称只存在于 main 分支,并且需要从源码构建。由于本指南基于尚未包含这项变更的公开版本,请继续使用 update 内容类型。

审阅检查点

进入第 4 集以前,确认:

  • 前两句说明结果和价值;
  • 证据已经命名或链接;
  • 不确定性没有被藏起来;
  • 没有凭据或私人笔记残留;
  • silan content lint 显示 0 fatal
  • 文章仍然保持私人。

第 4 集会改变公开状态。届时,如果你有 Docker,可以生成本地预览,并了解从预览到生产网址还需要哪些步骤。

0 次点赞
Silan Hu22 次阅读分享:

还没有评论