PowerShell社区博客技术文章审核指南

前言

作为PowerShell技术社区的重要组成部分，PowerShell社区博客承载着技术分享与知识传播的重要使命。本文将详细介绍技术文章审核的标准与规范，帮助投稿者了解如何撰写符合要求的优质技术文章。

文章提交规范

基础提交要求

1. 分支管理：所有投稿必须从工作分支提交，禁止直接在主分支上操作
2. 单篇文章原则：每个提交请求仅能包含一篇文章
3. 文件命名与存放：
   • 路径格式：Posts/yyyy/mm/文章标题.md
   • 文件名要求：
     • 使用小写字母
     • 不允许包含空格
     • 必须使用.md扩展名

作者信息验证

1. 个人资料完整性：
   • 必须提供真实姓名
   • 包含有效的个人简介链接
   • 使用适当的头像（建议使用真实照片）
2. 权限设置：投稿者需被设置为"作者"角色

内容质量标准

基础写作要求

1. 语言规范：
   • 语法正确
   • 拼写准确
   • 专业术语使用规范（如"PowerShell"而非"Powershell"）
2. 内容定位：
   • 以技术教学和信息分享为核心
   • 禁止营销或销售性质的内容
3. 版权声明：投稿者需确保拥有所提交内容的合法权利

元数据规范

每篇文章必须包含以下YAML格式的前置元数据：

---
post_title: 文章标题
username: WordPress用户名
categories: 从预定义分类中选择
tags: 从预定义标签中选择
featured_image: 可选特色图片URL
summary: 简短的文章摘要
---

技术文档格式规范

基础排版规则

1. 行文格式：
   • 行宽限制在100列以内（便于代码审查）
   • 使用空格而非制表符
   • 行尾不留空格
2. 特殊元素标注：
   • 内联代码使用反引号标注（如Get-Process）
   • 语义标记使用粗体（如参数名）
   • 强调内容使用斜体

标题层级规范

1. 层级结构：
   • 禁止使用H1标题（系统自动生成）
   • 使用ATX风格的标题标记
   • 标题采用句子大小写
   • 层级不可跳跃（如不能直接从H1跳到H3）
   • 最大深度建议不超过H4
2. 间距要求：标题前后需留空行

代码块规范

1. 基本格式：
   • 代码块前后需留空行
   • 使用带语言标记的代码围栏（如powershell）
2. 输出展示：命令输出应放在单独的powershell-console代码块中
3. 提示符使用：
   • 仅在展示命令行示例时使用提示符
   • 默认使用PS>，路径重要时才展示完整提示符

列表格式

1. 间距要求：
   • 列表前后需留空行
2. 缩进规范：
   • 列表项续行需与首行文本对齐
3. 标记选择：
   • 无序列表使用连字符（-）
   • 有序列表统一使用"1."

专业术语使用指南

1. 版本区分：
   • 准确使用"PowerShell"、"Windows PowerShell"和"PowerShell Core"等术语
2. 一致性原则：全文保持术语使用的一致性

外部链接规范

1. URL处理：
   • 去除Microsoft属性链接中的区域设置（如删除/en-us）
   • 去除文档链接中的版本查询参数
   • 优先使用HTTPS协议
2. 链接格式：
   • 禁止使用裸URL
   • 使用标准Markdown链接语法
   • 链接文本应为目标页面标题

结语

遵循这些规范不仅能提高文章通过审核的概率，更能提升文章的专业性和可读性。希望这些指南能帮助您撰写出高质量的PowerShell技术文章，为社区贡献有价值的技术内容。