WADComs项目技术文档编写规范详解

WADComs项目技术文档编写规范详解

WADComs.github.io WADComs is an interactive cheat sheet, containing a curated list of offensive security tools and their respective commands, to be used against Windows/AD environments. 项目地址: https://gitcode.com/gh_mirrors/wa/WADComs.github.io

项目背景与文档结构

WADComs项目是一个专注于Windows/Active Directory环境的命令速查手册，其核心价值在于为安全研究人员和系统管理员提供精准、可验证的命令参考。该项目采用严谨的技术文档结构，每个命令都通过标准化的YAML格式进行描述。

命令文档技术规范

基本文件结构

每个命令对应一个独立的Markdown文件，文件名采用<工具名称>.md的格式。文件内容完全由YAML front matter构成，不包含常规的Markdown内容。这种设计确保了数据结构的统一性和可解析性。

YAML字段详解

完整的YAML结构包含以下关键字段：

1. description：命令功能描述

   • 包含"Command Reference"子段，用于定义命令中的变量占位符
   • 标准化占位符包括：
     • Target IP: 10.10.10.1
     • Domain: test.local
     • Username: john
     • Password: password123

2. command：使用管道符(|)定义的多行命令内容

3. 分类标签：

   • items：命令关联的项目分类
   • services：命令依赖的远程服务
   • OS：命令可运行的操作系统平台
   • attack_types：攻击类型分类

4. references：参考资料链接集合

分类体系说明

项目维护着完善的分类体系，所有分类标签必须从预定义的枚举值中选择：

1. items：定义在专门的物品分类文件中，涵盖各种工具和技术类别
2. services：服务类型分类，如SMB、RDP等常见Windows服务
3. OS：操作系统平台分类，包括各种Linux发行版和Windows版本
4. attack_types：攻击类型分类，如Exploitation、Privilege Escalation等

技术文档编写最佳实践

命令验证要求

1. 每个提交的命令必须经过实际验证，确保至少在一个Windows版本上可正常运行
2. 命令中的变量部分必须使用标准占位符，保持整个项目的一致性
3. 复杂命令应当添加清晰的注释说明

分类标签使用规范

1. 必须包含命令所需的所有远程服务依赖
2. 准确标注命令可运行的源操作系统平台
3. 合理选择攻击类型分类
4. 参考资料部分必须至少包含工具下载链接

扩展分类体系

当现有分类无法满足需求时，可以提议添加新的分类项。新增分类需要经过技术审核，确保符合项目的整体分类逻辑和技术标准。

技术价值与实现原理

这种结构化文档设计具有以下技术优势：

1. 机器可读性：标准化的YAML格式便于自动化工具处理和索引
2. 一致性保证：通过预定义的分类体系确保文档质量统一
3. 可扩展性：模块化设计方便添加新命令和扩展分类
4. 快速检索：多维度的分类标签支持高效过滤和搜索

项目采用静态网站生成技术，这些结构化文档最终会被转换为便于浏览的网页形式，同时保持原始数据的完整性和可维护性。

通过遵循这些技术规范，WADComs项目能够为Windows/AD安全领域提供高质量、可信赖的命令参考资源。

WADComs.github.io WADComs is an interactive cheat sheet, containing a curated list of offensive security tools and their respective commands, to be used against Windows/AD environments. 项目地址: https://gitcode.com/gh_mirrors/wa/WADComs.github.io