小红书技术文章写作规范
文章结构要求
Frontmatter 格式
- •
title:简洁明确的标题,突出核心技术概念 - •
description:80-120 字的文章摘要,包含关键技术点 - •
pubDatetime:发布时间,使用 ISO 8601 格式 - •
tags:3-5 个相关技术标签,便于分类检索
内容长度控制
- •一级标题:即开始的内容介绍,控制在 200 字左右
- •二级标题:每个小节内容 150-250 字,且每个二级标题前使用
---分隔。生成二到四个二级标题内容。 - •保持内容精炼,避免冗余描述
写作风格指南
技术概念阐述
- •先给出概念定义,再解释工作原理
- •使用具体示例说明抽象概念
- •突出关键词使用
**粗体**标记 - •专业术语首次出现时提供简要解释
代码示例规范
javascript
// 提供完整、可运行的代码示例
// 添加必要的注释说明关键逻辑
const example = {
traceId: "4bf92f3577b34da6a3ce929d0e0e4736",
spanId: "00f067aa0ba902b7"
};
结构组织原则
- •概念介绍:从核心概念开始
- •技术细节:深入具体实现
- •实际应用:提供真实场景示例
- •最佳实践:总结使用建议
语言表达要求
- •使用简洁、准确的技术表达
- •避免口语化表述,保持专业性
- •中英文混排时注意空格规范
- •专业名词使用 "``" 包裹,如
OpenTelemetry
避免 AI 风格
撰写或润色时,文字要自然、人性化,避免明显的 AI 生成痕迹:
- •少用或不用「首先、其次、此外、综上所述、毋庸置疑、在这个……的时代」等套话与模板式过渡
- •避免排比堆砌、空洞升华、过度对称的句式结构
- •用具体技术细节和实例替代抽象概括,用动词和名词替代形容词堆砌
- •保持技术文章的专业性,但语言要流畅自然,像有经验的开发者在分享经验
- •避免「赋能」「助力」「打造」等营销话术渗入技术内容