菜单

概述

相关源文件

The Book of Secret Knowledge 是一个全面的技术资源、工具和参考集合,主要面向系统管理员、DevOps 工程师、安全研究人员和渗透测试人员。本文档介绍了存储库的目的、组织结构和目标受众。

目的与范围

此存储库作为一个集中的知识库,包含精心策划的宝贵资源列表,包括:

  • 用于各种技术任务的命令行和 GUI 工具
  • Web 实用程序和服务
  • 安全资源和渗透测试工具
  • 系统管理指南
  • DevOps 资源和容器编排工具
  • 网络分析和管理实用程序
  • 教育材料,如手册、教程和备忘单

主要目标是维护一个高质量的资源集合,可用作日常技术工作和持续学习的参考。

来源: README.md26-28 README.md30-32

存储库结构

The Book of Secret Knowledge 组织成一个单一的存储库,大部分内容直接包含在 README.md 文件中。内容被结构化为逻辑类别,以便于导航。

存储库结构图

来源: README.md1-25 README.md91-107

内容组织

该存储库的内容系统地组织成主要类别,每个类别包含相关资源的子类别。下图说明了主要内容结构:

内容组织图

来源: README.md109-380 README.md382-441 README.md443-636 README.md711-764 README.md766-785 README.md787-833 README.md835-1015 README.md1017-1091

目标受众

The Book of Secret Knowledge 旨在服务于各类技术专业人士:

受众主要用例相关部分
系统管理员系统配置、监控、故障排除CLI 工具、系统/服务、手册/操作指南
DevOps 工程师容器编排、CI/CD、自动化容器/编排、CLI 工具、系统/服务
安全研究员漏洞评估、安全测试安全工具、Web 工具、黑客/渗透测试
渗透测试人员安全测试、漏洞利用黑客/渗透测试、Web 工具、安全工具
网络工程师网络分析、配置、故障排除网络、CLI 工具(网络部分)
开发者脚本、编码最佳实践、调试Shell 单行命令、Shell 技巧、开发者资源

来源: README.md30-32

资源类别细分

命令行工具

命令行界面 (CLI) 工具部分是存储库中最大的类别,包含用于各种系统管理和安全任务的实用程序。这些工具根据功能组织成子类别。

CLI 工具类别结构

来源: README.md113-380

GUI & Web 工具

本节包括用于各种技术任务的图形用户界面工具和基于 Web 的实用程序,从终端仿真到安全测试。

GUI & Web 工具概述

来源: README.md382-441 README.md443-709

系统与网络

本节侧重于操作系统、网络服务和相关工具,重点关注面向安全的发行版和服务。

系统与网络结构

来源: README.md711-764 README.md766-785

教育与参考

这一广泛的部分包括涵盖各种技术领域的教程、手册、指南和参考资料。

教育资源结构

来源: README.md835-1015 README.md1017-1091 README.md1093-1107 README.md1099-1107

贡献指南

存储库维护着特定的贡献标准

  1. 内容必须是

    • 吸引人且清晰
    • 阅读起来不费力
    • 对目标受众有用
  2. 技术要求:

    • 易于贡献(使用 Markdown + HTML)
    • 易于查找(通过简单的目录结构)
  3. 质量标准

    • 不旨在包含所有内容,而只包含高质量的资源

有关详细的贡献指南,请参阅 贡献指南

来源: README.md33-57

如何使用该存储库

《秘密知识之书》旨在成为用户在需要特定工具或信息时可以参考的资源。以下是一些推荐的方法

  1. 按主题浏览:使用目录导航到感兴趣的特定类别
  2. 搜索方法:使用GitHub的搜索功能查找特定工具或主题
  3. 定期更新:订阅仓库的RSS feed,以了解新内容的最新动态
  4. 离线参考:将仓库克隆到本地,以便离线访问资源

该仓库会定期更新新资源,使其成为一个随着时间推移而不断发展的动态文档。

来源: README.md76-87

有关存储库特定方面的更多详细信息,请参阅

来源: README.md17-19 README.md33-57