首页 > 其他分享 >技术博客写作指南

技术博客写作指南

时间:2023-04-08 10:13:31浏览次数:28  
标签:指南 项目 技术 博客 学习 内容 写作 分享

目录

一、博客内容

1.学习框架

学习框架的内容,粗浅分为某职业学习路线某类技术学习内容

(1)某职业学习路线

用于介绍,在某类职业实际工作和项目设计中,所需要的技能,技能学习的顺序以及相应的时间安排。

介绍的内容可以包含介绍职业涉及领域,对于职业中会涉及到的知识进行说明分享;技能的学习顺序,在职业涉及较多的领域时,其中包含的知识点杂乱繁多,整理学习的顺序和逻辑进行分享,按照学习难易度,或项目规划学习;还可以针对知识给出大致的时间安排,以及学习程度等给出分析。

例如,知乎大神写的机器人工程大学学习路线规划:
image

(2)某类技术的学习内容

针对某类技术或软件的学习重点或难点,需要掌握的学习的内容整理。类似于项目的实现步骤,可以根据完成项目的技术要点,侧重学习,获得更多正反馈,增加学习兴趣。

例如前端框架实战学习内容:
image

2.技术点

(1)项目关键点

在使用开源项目时,在实现项目的过程中,对项目的关键点进行分析,并给出处理方式等。在实现复杂开源项目时,常常需要粗略理解项目包含的模块和相应功能,在实现项目的过程中,针对个人需求更改项目源码时,其中的关键函数、关键方法进行记录,便于重现。

例如,YOLOv5 自定义数据集方法整理:
image

(2)DeBug

开发或使用开源项目时,无可避免的会遇到 Bug,当解决 Bug 之后,进行记录,整理形成 DeBug list 对于之后的项目的实现留下参考。

3.学习方法和资源分享

学习方法和资源分享,分享学习技能时,所采用的方式并分享在学习过程中,自己所采用的方式的资源资料,提供参考。以项目为导向的学习,先找到实现项目的技术点,针对性学习其中的技术,复现项目进行学习,提供项目源码或项目地址;以书籍、视频为学习方式,给出书籍和视频的学习顺序,提供网址和书籍文件。

也可以针对在项目中所采用的软件的用途和优势,进行说明和介绍。

二、博客结构

1.标题

应该做到两个要点,标题简短不冗长、清晰表明作用目的。除两个要点之外,还可以加入项目所具有的特点。

2.导语

包含目录/整体大纲(思维导图),目录大多针对于博客内容中的技术点、学习方法和资源分享的逻辑整理;整体大纲(思维导图)常用于学习框架的整理。目录和整体大纲(思维导图)不仅能给出更清晰的逻辑,也便于在搜索时,更快的找到所需的位置。

3.主体内容

  • 条理清晰

依照目录或整体大纲(思维导图),进行主体内容的写作。

  • 内容易懂

避免使用较多的专有名词,那会使得内容的可读性降低。

  • 引用博客

当引用他人博客时,贴上相应的网址,便于他人查看详情。

  • 图文并茂

一定要避免通篇的长文以及全是文字的文章,图文并茂的写法,会增加阅读兴趣。

  • 注明项目软硬件版本型号

相同项目中,会由于软硬件版本型号的区别,而无法实现,注明实现相应的软硬件版本型号,便于复现。

例如,江大白深入浅出 Yolo 系列:
image

标签:指南,项目,技术,博客,学习,内容,写作,分享
From: https://www.cnblogs.com/Ricardo-Lu/p/17298004.html

相关文章

  • 初次接触女孩的指南 – 基本注意事项
    初次接触女孩的指南–基本注意事项一个害羞的男人如何接近女孩以获得友谊或长期关系的指南。做什么和不做什么。(仅适用于18岁以上)课程英文名:FirstTimersGuidetoApproachAGirl-BasicDo's&Don'ts此视频教程共nan,中英双语字幕,画质清晰无水印,源码附件全![](https:/......
  • EasyARM i.MX283A 完整系统制作指南(Linux 4.13.2+U-Boot 2017.09+BusyBox 1.27.2+Qt5
    原文:https://www.taterli.com/3213/标题老长呢.反正什么都是新的,所有都是开源的,除了下载工具以外,所有源码都有(据说下载工具也有,我懒得找了.),编译器源码自己也能做,但是没必要了.代码下载地址:https://github.com/nickfox-taterli/imx283a-new/releases/tag/v0.1首先有一个U......
  • 【博客说明】欢迎转载,转载请注明出处
    今天闲来无事网上闲逛逛,突然发现之前写的随笔《【Bug-Git】克隆远程仓库-fatal:unabletoaccess‘https:xxxx’OpenSSLSSL_read:Connectionwasreset,errno10054》和《【虚拟机】VMware-open-vm-tools安装》帮助了不少的朋友解决了问题,文章初发伊始便发现有不少朋友阅读,......
  • 新浪博客营销经验分享,优化推广两不误
    以前做过一个人才网站,通过新浪博客来做过相关营销。所以今天分享一些新浪博客的营销经验。对于新浪博客,有着非常好的优势,因为它的权重,当你在新浪博客上发布文章(原创基础),基本都是秒收。搜索引擎对于新浪博客的响应是非常快的。新浪博客的营销如何做?1.建立博客账号当然现在新浪博客处......
  • [博客入坑]CS231N assignment 1 _ KNN 知识 & 详细解析
    从零开始的全新博客我之前一直在语雀上更新文章,但是一会不更发现居然需要VIP才能发博客了:不过考虑到自己确实有一会没写博客了,之前对神经网络在课上学过,也鼓捣过pytorch,但是深感自己没有系统学习过.第一次接触这种公开课,希望也能有种从零开始的感觉,让自己面对这......
  • 运维监控必看:必懂的 InfluxDB 使用指南,关键时刻能用上
    InfluxDB是什么InfluxDB是一个由InfluxData开发的开源时序型数据库。它由Go写成,着力于高性能地查询与存储时序型数据。InfluxDB被广泛应用于存储系统的监控数据,IoT行业的实时数据等场景。技术特点包括:InfluxDB在技术实现上充分利用了Go语言的特性,无需任何外部依赖即可独立部......
  • API 测试 | 了解 API 接口测试 | API 接口测试指南
    什么是API?API是一个缩写,它代表了一个 pplication P AGC软件覆盖整个房间。API是用于构建软件应用程序的一组例程,协议和工具。API指定一个软件程序应如何与其他软件程序进行交互。例行程序:执行特定任务的程序。例程也称为过程,函数或子例程。协议:在两个系统之间传输数据的格......
  • 关于博客园绝境求商的一点点感想!
      作为一个非常古老(80后)的面向百度开发的程序员,我用百度非常多,大概在前几年的时候,搜技术关键字的时候,博客园上面的问题在百度首页出现的机会非常多,另外还有iteye这样的网站,但是在近几年发现越来越少了,首页基本上都是csdn的帖子,很多帖子都是无意义的复制,重复。虽然csdn的界面......
  • 目标检测中的“神奇指南”——平均精度(mAP)
    想象一下,你是一名私家侦探,接到一项神秘的任务,需要在一群人中找出一个罪犯。你必须仔细观察每个人的特征,比如身高、体型、发型、服装等等,从而识别出目标。这听起来似乎很简单,但是当人群中人头攒动、各种因素干扰时,你会发现自己很难进行准确的识别。目标检测任务也是如此。只不过,......
  • 如何通过博客文本直接发布二进制数据文件(非下载链接)
    是否想过,在博客中直接利用文本字符传播二进制数据?现在这个被我遗忘了近10年的便捷的工作完工了:《Base64&UUE文件编码解码工具》,直接将二进制文件编码为可由WinRAR解压的UUE纯文本格式文件,还可以先加密码,这样你就可以在博客中直接发布二进制文件了,下面就是这个小工具的可......