13 天前 我所在的公司的前端部门，每周都会开周会，然后其中一个环节就是做技术分享。我们是轮流每周一位前端同学做主持人，且必须做技术分享，其他人则是选择性分享。今天我们讲讲如何在团队内做技术分享。文档就好，没必要用 PPT我们的形式很简单，分享者将要分享的内容放到 协同在线文档，将链接发出来，然后分享者投屏到视频会议上。有些会议软件像飞书支持投屏文档，投出来的文档和浏览器打开没有区别，可以自由选择是否追随共享人的位置，个人觉得挺方便的，不需要自己一会看发出来的链接，一会看投屏。没必要一定要用 PPT 的形式分享。因为 PPT 制作比较麻烦，更适合正式的场合，比如汇报、对外的演讲。对内的技术分享，可以...

13 天前 开发者如何编写优雅的技术文档前言作为一名程序员，日常大部分的时间主要在埋头编码、调试。但在技术的世界里，不止有代码，如果仅仅只会编写程序是不够的。当你需要展示你的想法、技术分享、架构设计，这时候好的技术文档变的至关重要。文档伴随开发者的日常工作，例如：开源软件官方文档、第三方平台文档、系统设计文档等等，好的技术文档让人赏心悦目、赞不绝口，但其中也不乏文档让人抓狂。仔细观察会发现，多数优秀的项目不光有着优雅的代码，文档也非常棒。在项目开发进行时，常常会突破一些技术难点、技术无人区，这时候一篇经验总结类的技术博客可以帮你重新梳理、沉淀技术难题，当自己或是别人再次遇到时就能高效解决的解决问题。...

13 天前 前言最近部门在推技术分享的沉淀，每个小组平常也会有自己的技术分享。技术同学往往最擅长的是写代码，我们发现很多同学在做技术分享的时候，容易陷入仅仅把自己做的事情罗列出来的误区，难以收获好的分享效果。本文基于自己之前做技术分享的经验，同时结合了组内同学的建议，梳理了一些写技术分享文章的要点，目的是为了帮助技术同学更好的编写技术分享文档。 明确你的分享对象和分享目的• 明确你的分享对象：这次分享面向的是什么样的对象？同小组的技术同事、大部门的技术同事，还是社区的技术同学？• 明确你的分享目的：你做这次分享，目的是为了对方能够从中收获什么，是希望了解怎么实现这个技术方案？是希望能够找到适合的场...

13 天前 本文大部分内容翻译总结自《Software Engineering at Google》 第10章节 _Documentation_。 另外，该书电子版近日已经可以免费下载了 https://abseil.io/resources/swe_at_google.2.pdf，有兴趣的同学可以下载翻阅下。 首先声明，本问所说的文档不仅限于纯文本文档，还包含代码注释(注释也是一种特殊形式的文档)。很多技术人自己非常轻视技术文档的书写，然而又时常抱怨文档不完善、质量差、更新不及时…… 这种在程序猿间普遍存在的矛盾甚至已经演变成了一个段子。文档的重要性高质量的文档对于一个组织或团队来说有非常多的益处...

13 天前 作为程序员，除了会写代码，能查bug，还要会画图（UML建模）、做PPT（分享、述职等），更重要的是还要能写得出文档，并且能写出高大上的文档。根据过往的经验，技术文档一般会：项目文档：用于开启新项目的整体概要文档，说明项目背景、成员、依赖关系、项目整体排期、里程碑等信息。部署文档：介绍网站或系统如何进行部署，搭建运行环境，通常需要说明代码的Git仓库位置、数据库结构、Nginx/Apache配置、计划任务配置、其他配置，是否需要CDN或HTTPS等，以及注意事项。接口文档：针对每个API接口提供的文档，说明接口地址，调用方式，接口参数，返回结构，异常情况等。模板文档：提供给前端使用的模板...