Target 1,800 to 2,500 words with three to five figures.
A tool announcement has three readers at once, and naming them before drafting
settles most of the wording. There is a practitioner from the field the tool
serves, who knows the problem and not the method, and a practitioner from the
field the method comes from, who knows the method and not the problem. The third
is a hiring manager or a prospective collaborator skimming for whether the work
is real, and writing for the first two handles the third.
Treat the word count as a ceiling. Personal blog tool announcements in the
reference set run from 450 to 2,900 words, and the 450 word one does the whole
job. Announcing more than one tool in a single post is already ambitious, and
anything past 2,500 words loses the reader furthest from your field before the
section that carries the result.
Opening. Follow the DeepVariant pattern. Two or three paragraphs stating the
problem in numbers, then the announcement in the fourth. Never say the problem is
hard. Give the quantity that makes it hard and let the reader draw the
conclusion, the way a storage figure of 1.97 petabytes and a bill over $50,000 a
month settle the question without the word "expensive" appearing.
Openings to avoid, all drawn from real posts: a Human Genome Project preamble, a
definition both audiences already have,
<!-- prose-check:off -->
such as "DNA is the blueprint of life", and any first sentence containing "we are
proud to".
<!-- prose-check:on -->
The strongest available motivation is often not yours to assert, because someone
with more standing has already written it down. When the dominant tool in a field
disclaims the problem your work takes on, quote the disclaimer rather than
asserting the gap yourself. AlphaGenome's limitations section saying "We haven't
designed or validated AlphaGenome for personal genome prediction, a known
challenge for AI models" is the pattern to look for.
Section skeleton. Practitioner voice, infrastructure evidence sections,
institutional limitations section. Roughly:
- The problem, in numbers.
- What I built, and the headline number in a practical unit.
- How it works. One mechanism per tool, at the depth a reader needs to believe
the number.
- What it costs and what it buys, with the benchmark setup stated.
- What the tool made possible, which is the measurement.
- What it does not do.
- Resources.
Name sections for what the reader gets, not for what you implemented. MosaicML's
headings are the reusable form: "Correctness: no silent
pitfalls", "Efficiency: faster startup, lower costs". A section named for the
design decision most likely to be challenged is also good, in the shape of Simon
Willison's "Why an immutable API?".
Defining terms. Gloss inline in an aside, once, and never in a glossary box.
Evo 2 writes "over 9.3 trillion tokens, in this case nucleotides". Evo 1 writes
"Proteins, the tiny molecular machines that make cells function". Budget about
eight defined terms for the whole post. Past that, the post is a tutorial.
Numbers and figures. Numbers live in prose. Both Heng Li posts in the
reference set carry zero figures and are among the most persuasive. A figure
caption states the conclusion, not the axes. If a claim rests on a magnitude, the
magnitude goes in the sentence, and a figure is never the only place a headline
number appears.
One comparison table across competing tools is the single most useful artifact
for a reader deciding whether to switch.
Limitations. Mandatory, as its own section, and specific. A null result the
work was designed to test belongs here as the centrepiece rather than buried, and
it is reported with the effect size, the controls it ran under, and whether it
replicates out of sample. State the unexplained variance as a number, and bound
it with what is known about the terms the study did not measure.
Close. A named Resources list. Manuscript with DOI, code, docs, install line.
Do not close on a hiring pitch or a demo signup, which is the worst ending in the
reference set. If a third party has verified a number, say so in one sentence.
目标为 1,800 至 2,500 个词,配三到五幅图。
发布工具公告时,文章同时面对三类读者。动笔前先明确他们是谁,这能解决大部分措辞问题:一位来自工具所服务领域的从业者,了解问题但不了解方法;另一位来自方法所属领域的从业者,了解方法但不了解问题;第三位是招聘经理或潜在合作者,只会快速浏览,以判断这项工作是否真实。写好前两类读者,也就写好了第三类。
把字数当作上限。 参考集中的个人博客工具公告从 450 到 2,900 个词不等,而那篇 450 词的文章已经把任务完成得很好。在一篇文章中宣布多个工具本就已经很有野心,超过 2,500 个词,则会在承载结果的核心章节出现之前,先失去离本领域最远的读者。
开头。 遵循 DeepVariant 的模式。先用两到三段以数字说明问题,然后在第四段宣布消息。绝不要直接说问题很难。给出让它变得困难的量,让读者自行得出结论,就像 1.97 petabytes 的存储量和每月超过 50,000 美元的账单已经足以说明问题,无须出现 "expensive" 一词。
应避免的开头均取自真实文章:Human Genome Project 式前言;两类读者都已经知道的定义,
<!-- prose-check:off -->
例如 "DNA is the blueprint of life",以及任何第一句含有 "we are proud to" 的表达。
<!-- prose-check:on -->
可用的最强动机往往不适合由你亲自断言,因为更权威的人已经把它写下来了。当某个领域的主流工具承认了你的工作所处理的问题存在时,引用该免责声明,而不是自行断言存在缺口。AlphaGenome 的 limitations section 写道:"We haven't designed or validated AlphaGenome for personal genome prediction, a known challenge for AI models",这正是应该寻找的模式。
章节骨架。 采用从业者口吻,配置基础设施证据章节和机构限制章节。大致如下:
- 问题,用数字呈现。
- 你构建了什么,以及以实用单位表示的核心数字。
- 它如何工作。每个工具只讲一种机制,深入到足以让读者相信该数字的程度。
- 它需要什么成本,又能带来什么收益,并说明 benchmark setup。
- 该工具促成了什么,也就是测量结果。
- 它做不到什么。
- 资源。
章节名称应说明读者能得到什么,而不是你实现了什么。MosaicML 的
标题形式可以复用,例如 "Correctness: no silent pitfalls"、"Efficiency: faster startup, lower costs"。以最可能受到质疑的设计决策来命名章节也很好,例如 Simon Willison 的 "Why an immutable API?"。
术语定义。 在插入语中就地解释,一次即可,绝不要放进术语框。Evo 2 写 "over 9.3 trillion tokens, in this case nucleotides";Evo 1 写 "Proteins, the tiny molecular machines that make cells function"。整篇文章大约定义八个术语。超过这个数量,文章就变成教程了。
数字与图。 数字写在正文里。参考集中 Heng Li 的两篇文章都没有配图,却也是最有说服力的文章之一。图注要陈述结论,而不是坐标轴。如果某项主张依赖一个量级,就把该量级写进句子;图绝不能成为核心数字唯一出现的地方。
对于正在考虑是否切换工具的读者,一张跨竞争工具的比较表是最有用的单一材料。
限制。 必须单列一节,内容要具体。工作原本就是要检验的 null result,应作为核心内容放在这里,而不是埋在其他内容中;报告时写明 effect size、运行所依据的 controls,以及结果能否在 out-of-sample 条件下复现。用数字说明无法解释的 variance,并以研究所未测量的相关 terms 的已知范围来限定它。
结尾。 列出名称明确的 Resources。包含带 DOI 的 manuscript、代码、文档和安装命令。不要以招聘推销或 demo signup 收尾,这是参考集中最糟糕的结尾。如果有第三方验证过某个数字,用一句话说明。