当前位置： 首页 > news >正文

如何编写出色的技术文档

news 来源：原创 2025/7/15 4:03:07

目录

​编辑

1. 明确文档目的和受众

目的的重要性

了解受众

2. 收集和组织信息

信息收集的技巧

组织信息

3. 规划文档结构

结构规划的重要性

结构规划的步骤

4. 编写内容

语言和风格

内容的组织

编写技巧

5. 审阅和测试

审阅的重要性

测试的必要性

6. 版本控制和更新

版本控制的好处

更新的重要性

7. 易于导航

导航的重要性

导航的实现

8. 可访问性

可访问性的重要性

实现可访问性

9. 版权和法律信息

法律合规性

法律信息的包含

10. 发布和维护

发布渠道的选择

维护的重要性

维护的步骤

11. 反馈机制

反馈的价值

实施反馈机制

结语

在技术领域，文档不仅是产品的一部分，更是沟通的桥梁。一份好的技术文档能够指导用户正确使用产品，帮助开发者理解系统架构，同时也是企业知识传承的重要载体。本文将详细介绍如何编写一份出色的技术文档。

1. 明确文档目的和受众

目的的重要性

在编写技术文档之前，明确文档的目的至关重要。文档的目的可能是教育、指导、参考或通知。明确这一点可以帮助你确定需要包含哪些信息，以及如何组织这些信息。例如，教育性文档可能需要更多的背景信息和解释，而指导性文档则需要清晰的步骤和示例。文档的目的将指导你选择适当的语言风格、内容深度和细节程度。此外，目的还会影响文档的语气和复杂性。例如，如果你的文档是为了培训新员工，那么它可能需要更多的指导和示例，而如果你的文档是为了提供参考信息，那么它可能需要更详细的索引和搜索功能。

了解受众

了解你的受众是编写有效文档的关键。你需要知道他们的背景知识、他们的需求和他们可能遇到的问题。这将帮助你决定使用什么样的语言和术语，以及需要提供多少细节。例如，如果你的受众是技术新手，你可能需要避免使用复杂的术语，并提供更多的解释和上下文。如果你的受众是经验丰富的专业人士，你可以使用更多的专业术语，并深入探讨技术细节。了解受众还可以帮助你确定他们可能对哪些主题感兴趣，以及他们可能需要哪些类型的支持和资源。

2. 收集和组织信息

信息收集的技巧

在开始编写之前，收集所有必要的技术信息和背景资料是非常重要的。这可能包括产品规格、用户反馈、开发日志等。你需要确保收集的信息是全面的，不遗漏任何可能影响文档准确性的细节。同时，信息的准确性也至关重要，你需要核实信息的来源，确保信息是准确无误的。此外，信息的时效性也不容忽视，确保信息是最新的，反映产品的最新状态。这可能意味着你需要与产品团队紧密合作，以确保你拥有最新的信息。

组织信息

组织信息是编写技术文档的另一个关键步骤。你需要按照逻辑顺序组织信息，使读者能够顺畅地跟随你的思路。此外，将信息分门别类，便于读者查找和理解。例如，你可以将安装指南、配置选项、使用说明等分别归类，以便读者可以快速找到他们需要的信息。组织信息还可以帮助你确定哪些信息是最重要的，哪些可以作为附录或附加资源提供。这有助于保持文档的清晰和专注，避免信息过载。

3. 规划文档结构

结构规划的重要性

一个良好的结构不仅有助于读者理解文档，也有助于作者组织思路。它应该清晰地指示出文档的流程和重点，使读者能够快速找到他们需要的信息。通常，技术文档会包括以下部分：引言、概述、安装指南、使用说明、故障排除、附录等。每个部分都应该有明确的目的和内容，相互之间逻辑清晰，易于读者理解。一个清晰的结构还可以帮助读者预测文档的内容，提高他们的阅读效率。

结构规划的步骤

规划文档结构时，你可以遵循以下步骤：

  1. 确定文档的主要部分：根据文档的目的和内容，确定文档的主要部分，如引言、概述、安装指南等。
  2. 为每个部分创建子标题：为每个主要部分创建子标题，进一步细化内容。
  3. 确定内容的顺序：确定各部分和子标题的顺序，确保逻辑清晰。
  4. 创建目录：根据结构创建目录，方便读者快速导航。目录应该包含所有章节和子章节的链接，方便读者快速跳转。

4. 编写内容

语言和风格

在编写技术文档时，使用清晰、简洁的语言是非常重要的。这不仅可以提高文档的可读性，还可以帮助读者更快地理解信息。避免使用行业术语，或者在首次出现时提供定义。此外，保持术语和格式的一致性也是非常重要的，这有助于读者更好地理解文档内容。一致性还可以帮助建立文档的专业性和可信度。

内容的组织

在组织内容时，使用清晰的编号列表来指导操作步骤，这有助于读者按照步骤操作。同时，使用图表、流程图和代码示例来辅助说明，可以使复杂的信息更加直观易懂。确保所有步骤都是可操作的，并且经过测试，这可以确保文档的实用性和准确性。测试步骤还可以帮助你发现可能的问题和错误，提前解决这些问题。

编写技巧

  1. 使用主动语态：尽量使用主动语态，使文档更加直接和有力。
  2. 避免冗余：避免不必要的重复和冗余信息，保持内容的紧凑性。
  3. 使用列表和表格：使用列表和表格来组织信息，提高可读性。

5. 审阅和测试

审阅的重要性

审阅是确保文档质量的关键步骤。它可以帮助发现错误、不一致和不清晰的表达，确保文档的准确性和可用性。同行审阅可以让其他团队成员提供反馈，这有助于发现可能被忽视的问题。用户测试可以让目标受众测试文档，确保信息的准确性和易用性。技术验证可以验证所有技术信息和步骤的正确性，确保文档的可靠性。

测试的必要性

测试是验证文档实用性的重要环节。通过实际测试，可以发现文档中可能遗漏或错误的地方，确保文档能够真正帮助用户解决问题。测试可以包括功能测试、性能测试、可用性测试等，确保文档在各个方面都能满足用户的需求。测试还可以帮助你了解用户的实际体验，从而改进文档的设计和内容。

6. 版本控制和更新

版本控制的好处

版本控制不仅可以帮助管理文档的变更，还可以追踪文档的历史，方便回溯和比较不同版本之间的差异。这对于维护文档的一致性和准确性非常重要。通过版本控制，你可以轻松地查看文档的变更历史，了解每个版本的具体变化。版本控制还可以帮助你管理文档的协作和审阅过程，确保所有更改都是经过审查和批准的。

更新的重要性

产品在不断更新，文档也需要随之更新。及时的更新可以确保文档始终反映产品的最新状态，避免误导用户。定期检查文档，确保所有信息都是最新的，这对于维护文档的可靠性和有效性至关重要。更新文档还可以帮助你保持与用户的良好关系，展示你对产品质量和用户体验的承诺。

7. 易于导航

导航的重要性

良好的导航可以帮助读者快速定位到他们感兴趣的部分，提高文档的可用性。提供详细的目录和索引，方便读者快速找到所需信息。此外，使用超链接在文档的不同部分之间建立连接，可以使读者在阅读过程中更加流畅地跳转。良好的导航还可以减少用户的挫败感，提高他们的满意度。

导航的实现

  1. 创建详细的目录：目录应该包含所有章节和子章节的链接，方便读者快速跳转。
  2. 使用面包屑导航：面包屑导航可以帮助读者了解他们在文档中的位置，并快速返回上一级。
  3. 提供搜索功能：搜索功能可以帮助读者快速找到关键词相关的信息。

8. 可访问性

可访问性的重要性

可访问性是确保所有用户都能平等使用文档的重要方面。这不仅包括视觉障碍用户，还包括听力障碍用户和运动障碍用户。使用适当的标签和替代文本，确保文档对所有用户都是可访问的。这不仅有助于提高文档的可用性，也是遵守法律法规的要求。可访问性还可以扩大你的受众范围，提高你的产品的市场竞争力。

实现可访问性

  1. 使用替代文本：为所有图像和图表提供替代文本，使屏幕阅读器能够读取。
  2. 提供字幕和音频描述：为视频和音频内容提供字幕和音频描述。
  3. 确保足够的对比度：确保文档的文本和背景之间有足够的对比度，以便视觉障碍用户阅读。

9. 版权和法律信息

法律合规性

遵守版权法和其他相关法律是编写文档时必须考虑的问题。这不仅涉及到保护作者的权益，也涉及到保护用户的权益。包括版权声明和任何必要的法律信息，确保遵守所有相关的法律和规定。这有助于避免法律纠纷，保护企业和用户的利益。法律合规性还可以帮助你建立企业的正面形象，展示你对法律和道德规范的尊重。

法律信息的包含

  1. 版权声明：在文档中包含版权声明，明确文档的版权归属。
  2. 免责声明：包含免责声明，明确文档的使用风险和责任限制。
  3. 合规性声明：如果适用，包含合规性声明，确保文档符合特定行业或地区的法规要求。

10. 发布和维护

发布渠道的选择

选择合适的发布渠道可以确保文档能够到达目标受众。这可能包括在线平台、纸质出版物或其他媒介。考虑受众的偏好和习惯，选择最合适的发布渠道。例如，对于技术文档，在线平台可能是一个更好的选择，因为它可以方便地更新和访问。选择合适的发布渠道还可以帮助你控制文档的分发和使用，确保信息的安全和保密。

维护的重要性

文档的维护是一个持续的过程。随着产品的更新和用户反馈的积累，文档也需要不断更新和改进。定期检查文档，确保所有信息都是最新的，这对于维护文档的可靠性和有效性至关重要。维护文档还可以帮助你保持与用户的沟通，展示你对产品质量和用户体验的持续关注。

维护的步骤

  1. 定期审查：定期审查文档，检查信息的准确性和时效性。
  2. 更新内容：根据产品更新和用户反馈更新文档内容。
  3. 收集反馈：收集用户反馈，了解文档的不足之处，并进行改进。

11. 反馈机制

反馈的价值

用户的反馈是改进文档的宝贵资源。通过收集和分析反馈，可以发现文档的不足之处，并进行相应的改进。提供一种方式让读者可以提供反馈，如在线调查、电子邮件或社交媒体等。这有助于收集用户的意见和需求，从而改进文档的内容和形式。反馈还可以帮助你了解用户的实际体验，从而改进你的产品和服务质量。

实施反馈机制

  1. 提供反馈渠道：在文档中提供反馈渠道，如联系表单或电子邮件地址。
  2. 分析反馈：定期分析收集到的反馈，识别文档的改进点。
  3. 实施改进：根据反馈实施改进措施，提高文档的质量。

结语

编写技术文档是一个需要耐心和细致的工作，但它对于产品的成功至关重要。通过遵循上述步骤，你可以创建出既准确又易于理解的技术文档，帮助用户和开发者更好地使用和理解你的产品。记住，技术文档是一个持续的过程，需要不断地更新和改进以保持其相关性和准确性。

相关文章：

如何编写出色的技术文档

目录 ​编辑 1. 明确文档目的和受众 目的的重要性 了解受众 2. 收集和组织信息 信息收集的技巧 组织信息 3. 规划文档结构 结构规划的重要性 结构规划的步骤 4. 编写内容 语言和风格 内容的组织 编写技巧 5. 审阅和测试 审阅的重要性 测试的必要性 6. 版本控…...

编程日记 2025/7/15 4:03:07

摄像头原始数据读取——gstreamer(gst_parse_launch)

摄像头原始数据读取——gstreamer(gst_parse_launch) #include <stdio.h> #include <string.h> #include <stdlib.h>#ifdef __cplusplus extern "C" { #endif#include <gst/gst.h>#ifdef __cplusplus }; #endifstatic gboolean bus_msg_tim…...

编程日记 2025/7/15 1:12:12

矩阵/矩阵乘法/特征值/特征向量的讲解

线性代数里有很多的概念&#xff0c;很多概念是有几何意义的&#xff0c;了解了几何意义可能会更好的理解各种概念及其相互之间的关系。 矩阵&#xff1a; 矩阵是一个变换&#xff0c;一个坐标系到另一个坐标系的变换。矩阵里的各个参数&#xff0c;代表了如何进行变换。 矩阵…...

编程日记 2025/7/13 18:16:11

docker-compose搭建xxl-job、mysql

docker-compose搭建xxl-job、mysql 1、搭建docker以及docker-compose2、下载xxl-job需要数据库脚本3、创建文件夹以及docker-compose文件4、坑来了5、正确配置6、验证-运行成功 1、搭建docker以及docker-compose 略 2、下载xxl-job需要数据库脚本 下载地址&#xff1a;https…...

编程日记 2025/7/10 23:13:24

《图像形态学运算全解析：原理、语法及示例展示》

简介&#xff1a; 本文详细介绍了图像形态学中的多种运算&#xff0c;包括腐蚀、膨胀、开运算、闭运算、形态学梯度运算、礼帽运算以及黑帽运算。分别阐述了各运算的原理、语法格式&#xff0c;并通过 Python 代码结合具体示例图片&#xff08;如erode.JPG、dilate.JPG、close.…...

编程日记 2025/7/13 22:16:40

【面试分享】C++ 中结构体（struct）和类（class）的区别

在 C中&#xff0c;结构体&#xff08;struct&#xff09;和类&#xff08;class&#xff09;有一些相似之处&#xff0c;但也存在一些重要的区别&#xff1a; 一、默认访问权限 结构体&#xff1a; 在 C中&#xff0c;结构体的默认成员访问权限是public&#xff08;公有&…...

编程日记 2025/7/14 9:03:01

Rk3588 onnx转rknn，出现 No module named ‘rknn‘

一、操作步骤&#xff1a; rk3588 需要将yolo11 的模型onnx转rknn。 https://github.com/airockchip/rknn_model_zoo/tree/main/examples/yolo11 这个是用yolo11训练的模型&#xff0c;有80种类型。 完整下载下来后&#xff0c;在按文档描述下载模型下来&#xff1a; 然后进…...

编程日记 2025/7/10 22:09:11

HarmonyOS：@Provide装饰器和@Consume装饰器：与后代组件双向同步

一、前言 Provide和Consume&#xff0c;应用于与后代组件的双向数据同步&#xff0c;应用于状态数据在多个层级之间传递的场景。不同于上文提到的父子组件之间通过命名参数机制传递&#xff0c;Provide和Consume摆脱参数传递机制的束缚&#xff0c;实现跨层级传递。 其中Provi…...

编程日记 2025/7/8 18:35:17

在并发情况下，Elasticsearch如果保证读写一致？

大家好&#xff0c;我是锋哥。今天分享关于【在并发情况下&#xff0c;Elasticsearch如果保证读写一致&#xff1f;】面试题。希望对大家有帮助&#xff1b; 在并发情况下&#xff0c;Elasticsearch如果保证读写一致&#xff1f; 1000道 互联网大厂Java工程师 精选面试题-Java…...

编程日记 2025/7/15 1:28:22

通过 SSH 进行WordPress网站的高级服务器管理

我在管理hostease的服务器时&#xff0c;时常需要通过SSH登录服务器进行修改。而在网站管理中&#xff0c;SSH不仅是一个基础工具&#xff0c;更是高级用户用来精细化管理和优化服务器的重要工具。通过SSH&#xff0c;你可以深入监控服务器的性能、精细管理系统资源&#xff0c…...

编程日记 2025/7/12 23:47:00

关闭AWS账号后，服务是否仍会继续运行？

在使用亚马逊网络服务&#xff08;AWS&#xff09;时&#xff0c;用户有时可能会考虑关闭自己的AWS账户。这可能是因为项目结束、费用过高&#xff0c;或是转向使用其他云服务平台。然而&#xff0c;许多人对关闭账户后的服务状态感到困惑&#xff0c;我们九河云和大家一起探讨…...

编程日记 2025/7/15 1:28:07

PostgreSQL数据库参数调优实践

PostgreSQL&#xff08;简称PG&#xff09;数据库的性能调优是一个复杂但至关重要的过程&#xff0c;特别是在处理大量数据和复杂查询时。通过合理设置和调整数据库参数&#xff0c;可以显著提升数据库的性能和响应速度。本文将从多个方面详细介绍PostgreSQL数据库参数调优的实…...

编程日记 2025/7/13 1:14:11

Leetcode - 144双周赛

目录 一&#xff0c;3360. 移除石头游戏 二&#xff0c;3361. 两个字符串的切换距离 三&#xff0c;3362. 零数组变换 III 四&#xff0c;3363. 最多可收集的水果数目 一&#xff0c;3360. 移除石头游戏 本题直接模拟过程&#xff0c;可以额外使用一个布尔变量标记谁赢&…...

编程日记 2025/7/13 8:39:26

微信小程序全局配置：TabBar与页面配置详解

微信小程序全局配置：TabBar与页面配置详解 引言 随着移动互联网的迅猛发展，微信小程序作为一种新兴的应用形式，因其便捷性和丰富的功能而受到广泛欢迎。在小程序的开发过程中，全局配置是非常重要的一环，尤其是tabBar和页面的配置。本文将深入探讨微信小程序的全局配置，…...

编程日记 2025/7/9 20:06:32

Linux创建免密登陆（错误：Permission denied (publickey,gssapi-keyex,gssapi-with-mic)）

报错截图 解决方法 1. mkdir -p ~/.ssh 2. chmod 700 ~/.ssh 3. ssh-keygen&#xff0c;一直回车 4. chmod 600 /root/.ssh/id_rsa 5. 将公钥内容追加到服务器上&#xff0c;cat ~/.ssh/id_rsa.pub >> ~/.ssh/authorized_keys 6. chmod 600 ~/.ssh/authorized_keys…...

编程日记 2025/7/9 17:52:41

机器学习深掘临床研究中小分子代谢标志物的探索与应用

摘要 随着生命科学的发展&#xff0c;小分子生物标志物在临床研究中的作用日益凸显。机器学习技术为挖掘小分子生物标志物提供了强大工具。本文介绍了小分子生物标志物的定义、分类及在临床医学中的应用&#xff0c;阐述了常用机器学习算法在生物标志物挖掘中的优势&#xff0…...

编程日记 2025/7/12 18:33:09

计算机网络 第4章 网络层

计算机网络 &#xff08;第八版&#xff09;谢希仁 第 4 章 网络层4.2.2 IP地址**无分类编址CIDR**IP地址的特点 4.2.3 IP地址与MAC地址4.2.4 ARP 地址解析协议4.2.5 IP数据报的格式题目2&#xff1a;IP数据报分片与重组题目&#xff1a;计算IP数据报的首部校验和(不正确未改) …...

编程日记 2025/7/12 19:22:03

Android按键点击事件三种实现方法

1. 在xml文件中为 Button 添加android:onclick属性 由于没有onclick这个函数&#xff0c;onclick下面会提示红色波浪线错误&#xff0c;然后单击一下"onclick"按住键盘上AltEnter键,选择在activity中生成函数 public void onclick(View view) {Toast.makeText(this,&…...

编程日记 2025/7/13 9:57:27

微信小程序中会议列表页面的前后端实现

题外话&#xff1a;想通过集成腾讯IM来解决即时聊天的问题&#xff0c;如果含语音视频&#xff0c;腾讯组件一年5万起步&#xff0c;贵了&#xff01;后面我们改为自己实现这个功能&#xff0c;这里只是个总结而已。 图文会诊需求 首先是个图文列表界面 同个界面可以查看具体…...

编程日记 2025/7/13 8:06:16

决策树——基于乳腺癌数据集与cpu数据集实现

决策树——乳腺癌数据实现 4.1 训练决策树模型，并计算测试集的准确率 1. 读入数据 from sklearn import datasets from sklearn.tree import DecisionTreeClassifier from sklearn.model_selection import train_test_split from sklearn.metrics import confusion_matrix …...

编程日记 2025/7/14 14:39:15

2024年11月24日Github流行趋势

项目名称&#xff1a;FreeCAD 项目维护者&#xff1a;wwmayer, yorikvanhavre, berndhahnebach, chennes, WandererFan等项目介绍&#xff1a;FreeCAD是一个免费且开源的多平台3D参数化建模工具。项目star数&#xff1a;20,875项目fork数&#xff1a;4,117 项目名称&#xff1…...

编程日记 2025/7/14 20:21:14

库的操作.

创建、删除数据库 创建语法&#xff1a; CREATE DATABASE [IF NOT EXISTS] db_name[ ]是可选项&#xff0c;IF NOT EXISTS 是表明如果不存在才能创建数据库 //查看数据库&#xff0c;假设7行 show databases; //创建数据库 --- 本质在Linux创建一个目录 create database databa…...

编程日记 2025/7/13 11:19:59

Go错误与日志处理—推荐实践

错误的分类 在 Go 语言中&#xff0c;错误是通过实现 error 接口的类型表示的&#xff0c;但不同场景下的错误可以按性质和用途进行分类。以下是 Go 语言错误的常见分类&#xff0c;以及每类错误的解释和示例&#xff1a; 标准错误类型 标准库中定义了许多常见的错误类型&…...

编程日记 2025/7/10 16:36:12

文件上传upload-labs-docker通关

&#xff08;图片加载不出&#xff0c;说明被和谐了&#xff09; 项目一&#xff1a; sqlsec/ggctf-upload - Docker Image | Docker Hub 学习过程中,可以对照源码进行白盒分析. 补充&#xff1a;环境搭建在Linux虚拟机上的同时&#xff0c;以另一台Windows虚拟机进行测试最…...

编程日记 2025/7/4 15:42:50

C语言——数组基本知识（一）

目录 一.一维数组的初始化 二.数组的排序 ①冒泡排序&#xff1a; 代码&#xff1a; 没有第二个for循环运行结果如下&#xff1a; 正确的运行结果如下&#xff1a; ②选择排序 代码如下&#xff1a; 运行结果如图&#xff1a; 往期回顾&#xff1a; 一.一维数组的初始…...

编程日记 2025/7/12 6:16:33

vue2日历组件

【效果图】 <template><div style"width: 100%"><!-- <div> --><!-- <div>{{ startDate.getMonth() 1 - startDate.getDate() }}</div><div>{{ endDate.getMonth() 1 - endDate.getDate() }}</div> --&g…...

编程日记 2025/7/13 23:35:58

Unity C# 影响性能的坑点

c用的时间长了怕unity的坑忘了&#xff0c;记录一下。 GetComponent最好使用GetComponent<T>()的形式&#xff0c; 继承自Monobehaviour的函数要避免空的Awake()、Start()、Update()、FixedUpdate().这些空回调会造成性能浪费 GetComponent方法最好避免在Update当中使用…...

编程日记 2025/7/10 7:52:39

Redis（概念、IO模型、多路选择算法、安装和启停）

一、概念 关系型数据库是典型的行存储数据库&#xff0c;存在的问题是&#xff0c;按行存储的数据在物理层面占用的是连续存储空间&#xff0c;不适合海量数据存储。 Redis在生产中使用的最多的是用作数据缓存。 服务器先在缓存中查询数据&#xff0c;查到则返回&#xff0c;…...

编程日记 2025/7/14 11:19:47

多线程

线程是什么&#xff1f; 1、线程是进程的执行分支&#xff0c;一个进程内部的控制程序 2、一个进程至少有一个执行线程 3、从CPU角度来看&#xff0c;线程就是一个更轻量化的线程 4、线程在进程内部运行&#xff0c;所以本质就是在进程地址空间上运行 注意&#xff1a; 一…...

编程日记 2025/7/13 12:08:11

Spring Boot林业产品推荐系统：用户指南

摘 要 网络技术和计算机技术发展至今&#xff0c;已经拥有了深厚的理论基础&#xff0c;并在现实中进行了充分运用&#xff0c;尤其是基于计算机运行的软件更是受到各界的关注。加上现在人们已经步入信息时代&#xff0c;所以对于信息的宣传和管理就很关键。因此林业产品销售信…...

编程日记 2025/7/13 23:22:54

计算机网络 实验八 应用层相关协议分析

一、实验目的 熟悉CMailServer邮件服务软件和Outlook Express客户端软件的基本配置与使用&#xff1b;分析SMTP及POP3协议报文格式和SMTP及POP3协议的工作过程。 二、实验原理 为了观察到邮件发送的全部过程&#xff0c;需要在本地计算机上配置邮件服务器和客户代理。在这里我…...

编程日记 2025/7/12 13:37:10

实战ansible-playbook：Ansible Vault加密敏感数据(三)

在实际生产环境中，使用 Ansible Vault 来加密敏感数据是一种常见的做法。以下是一个详细的步骤和实际生产环境的使用案例，展示如何使用 Ansible Vault 来加密和管理敏感数据。 1. 安装 Ansible 确保你已经安装了 Ansible。如果还没有安装，可以使用以下命令进行安装： # 在…...

编程日记 2025/7/14 20:24:02

oracle 12c查看执行过的sql及当前正在执行的sql

V$SQL 提供了已经执行过及正在执行的SQL语句的信息。 一 查看共享池中所有sql的统计信息 #统计共享池中某类sql执行次数&#xff0c;总体执行时长&#xff0c;平均执行时长等信息&#xff0c;并按总体执行时长降序排序 SELECT INST_ID,SQL_ID,SQL_TEXT,SQL_FULLTEXT,EXECUTI…...

编程日记 2025/7/12 17:32:13

【大模型】Spring AI Alibaba 对接百炼平台大模型使用详解

目录 一、前言 二、Spring AI概述 2.1 spring ai是什么 2.2 Spring AI 核心能力 2.3 Spring AI 应用场景 三、Spring AI Alibaba 介绍 3.1 Spring AI Alibaba 是什么 3.2 Spring AI Alibaba 核心特点 3.3 Spring AI Alibaba 应用场景 四、SpringBoot 对接Spring AI Al…...

编程日记 2025/7/13 18:24:27

CSS：怎么把网站都变成灰色

当大家看到全站的内容都变成了灰色&#xff0c;包括按钮、图片等等。这时候我们可能会好奇这是怎么做到的呢&#xff1f; 有人会以为所有的内容都统一换了一个 CSS 样式&#xff0c;图片也全换成灰色的了&#xff0c;按钮等样式也统一换成了灰色样式。但你想想这个成本也太高了…...

编程日记 2025/7/11 1:35:05

Maven 常用命令

Maven 是一个强大的构建自动化工具&#xff0c;主要用于 Java 项目的管理和构建。 理解 Maven 命令对于高效管理与构建您的 Java 项目至关重要。 在本篇博客中&#xff0c;我们将探索每个 Java 开发者都应该掌握的一些最重要的 Maven 命令。 1. 设置 Maven 在深入探讨 Mave…...

编程日记 2025/7/13 5:05:31

【算法day1】数组：双指针算法

题目引用 这里以 1、LeetCode704.二分查找 2、LeetCode27.移除元素 3、LeetCode977.有序数组的平方 这三道题举例来说明数组中双指针的妙用。 1、二分查找 给定一个 n 个元素有序的&#xff08;升序&#xff09;整型数组 nums 和一个目标值 target &#xff0c;写一个函数搜…...

编程日记 2025/7/13 8:06:38

CTF之密码学（DES）

一、基本原理 DES加密使用相同的密钥进行加密和解密操作。它使用一个56位的密钥&#xff08;另外8位为奇偶校验位&#xff0c;不直接参与加密过程&#xff0c;因此实际密钥长度为56位&#xff09;&#xff0c;对64位的数据块进行加密&#xff0c;得到64位的密文。加密过程主要…...

编程日记 2025/7/14 18:00:46

【css实现收货地址下边的平行四边形彩色线条】

废话不多说&#xff0c;直接上代码&#xff1a; <div class"address-block" ><!-- 其他内容... --><div class"checked-ar"></div> </div> .address-block{height:120px;position: relative;overflow: hidden;width: 500p…...

编程日记 2025/7/9 17:28:24

Linux—进程概念学习-03

目录 Linux—进程学习—31.进程优先级1.1Linux中的进程优先级1.2修改进程优先级—top 2.进程的其他概念3.进程切换4.环境变量4.0环境变量的理解4.1环境变量的基本概念4.2添加环境变量—export4.3Linux中环境变量的由来4.4常见环境变量4.5和环境变量相关的命令4.6通过系统调用获…...

编程日记 2025/7/13 10:54:55

设计模式之破环单例模式和阻止破坏

目录 1. 序列化和反序列化2. 反射 这里单例模式就不多说了 23种设计模式之单例模式 1. 序列化和反序列化 这里用饿汉式来做例子 LazySingleton import java.io.Serializable;public class LazySingleton implements Serializable {private static LazySingleton lazySinglet…...

编程日记 2025/7/13 11:55:43

c++(斗罗大陆)

这次&#xff0c;作者编了斗罗大陆的武魂、魂力等级&#xff0c;目前只写到了11级 #include<iostream> #include<conio.h> #include<windows.h> #include<stdlib.h> #include<stdio.h> #include<time.h> #include<strin…...

编程日记 2025/7/14 11:33:52

NodeJs使用Addon调用C++

本文介绍的是NodeJs使用node-addon-api调用C的方法 node-addon-api是一个C封装&#xff0c;基于N-API构建&#xff0c;目的是提供一个更高级和更易用的接口&#xff0c;但它仍然依赖N-API。 官方参考文档 开发环境 必须具备NodeJs环境 Window配置NodeJs环境&#xff08;绅士版…...

编程日记 2025/7/9 23:16:04

YOLOv11（Ultralytics）视频选定区域目标统计计数及跟踪

在计算机视觉的众多应用场景中&#xff0c;对特定区域的目标进行检测、跟踪与计数是一个常见且重要的需求。无论是在智慧交通中统计通过特定路口的车辆数量&#xff0c;还是在零售分析中追踪进入特定区域的顾客行为&#xff0c;这一功能都发挥着不可或缺的作用。 随着深度学习…...

编程日记 2025/7/11 1:58:26

【Nginx系列】Nginx配置优先级

&#x1f49d;&#x1f49d;&#x1f49d;欢迎来到我的博客&#xff0c;很高兴能够在这里和您见面&#xff01;希望您在这里可以感受到一份轻松愉快的氛围&#xff0c;不仅可以获得有趣的内容和知识&#xff0c;也可以畅所欲言、分享您的想法和见解。 推荐:kwan 的首页,持续学…...

编程日记 2025/7/8 22:46:39

搭建私有docker仓库

1. 安装docker依赖包 sudo yum install -y yum-utils device-mapper-persistent-data lvm2 sudo yum-config-manager --add-repo https://mirrors.aliyun.com/docker-ce/linux/centos/docker-ce.repo sudo yum install docker-ce docker-ce-cli containerd.io sudo systemctl …...

编程日记 2025/7/15 1:16:34

C语言练级-＞##__VA_ARGS__(可变参数)的用法

有什么用&#xff1f; 通常__VA_ARGS__用于宏定义&#xff0c;其中关于日志宏需要用的&#xff0c;printf 等支持可变参数的函数的宏封装。 首先我们先知道这个__VA_ARGS__的英文全称是“Variadic Arguments” 叫可变参数。说到可变参数学过C语言的朋友们应该都会想到printf&…...

编程日记 2025/7/14 23:12:54

在 wordpress 中简易目录插件添加滑动条

实现思路 给目录容器添加一个 固定高度&#xff0c;并设置 CSS 的 overflow 属性 为 auto 或 scroll&#xff0c;使其内容可滚动。确保目录的滚动行为独立于页面的整体滚动。优化用户体验&#xff0c;添加平滑滚动效果。 操作步骤 1. 检查目录的 HTML 结构 首先&#xff0c;…...

编程日记 2025/7/13 16:02:34

Linux和Ubuntu的关系

Linux和Ubuntu的关系&#xff1a; 1. Linux本身是内核&#xff0c;Ubuntu系统是基于Linux内核的操作系统。 2. Linux内核操作系统的构成&#xff1a; 内核、shell、文件系统、应用程序 -应用程序&#xff1a;文本编辑器等 -文件系统&#xff1a;文件存放在存储设备上的组织方…...

编程日记 2025/7/14 5:51:00

【大数据学习 | Spark-Core】详解Spark的Shuffle阶段

1. shuffle前言 对spark任务划分阶段&#xff0c;遇到宽依赖会断开&#xff0c;所以在stage 与 stage 之间会产生shuffle&#xff0c;大多数Spark作业的性能主要就是消耗在了shuffle环节&#xff0c;因为该环节包含了大量的磁盘IO、序列化、网络数据传输等操作。 负责shuffle…...

编程日记 2025/7/11 18:59:34