BR 技术头条
mp mp.weixin.qq.com / 2021-01-26 00:46 / by @code小生

这份《REAME 书写指南》送给不写文档的程序员

如果你很着急、只是想要模板,可以直接跳到底部(但这样一点不酷),准备酷的人,迈出成为README大师的第一步吧!(绝对不是点击诱饵)

赞过的人

@code小生

发表评论

相关分享

ma mazhuang.org / 2023-11-06 22:46

读书|程序员如何传书到 Kindle

本篇记录一下我传书到 Kindle 的「独特」方式——WiFi 传书插件。可以直接通过 WiFi 传输电子书到 Kindle,不需要使用 USB 线,也不依赖其它服务,只要 Kindle 和手机/电脑在同一个局域网内,就可以通过浏览器直接上传电子书到 Kindle。

无图
in insights.thoughtworks.cn / 2023-08-16 14:07

如何编写技术文档?

所谓编写技术文档,基本意味着以结构化的方式组织文档,传达出清晰明确的信息,来让用户正确的使用你的软件产品。结构化文档不仅仅是当前最为主流的文档组织方式,在可预见的未来也会如此。

无图
li linux.cn / 2023-04-16 21:10

使用 CSS 提升你的 HTML 文档

当你编写文档时,无论是为开源项目还是技术写作项目,你都应该有两个目标:文档应该写得好,同时要易于阅读。前者通过清晰的写作技巧和技术编辑来解决。第二个目标可以通过对 HTML 文档进行一些简单的更改来解决。
超文本标记语言(HTML)是互联网的支柱。自 1994 年“万维网”问世以来,所有网络浏览器都使用 HTML 来显示文档和网站。几乎与此同时,HTML 一直支持样式表,它是对 HTML 文档的一种特殊添加,用于定义文本在屏幕上的呈现方式。
单纯用 HTML 编写项目文档也是可以的。然而,纯 HTML 样式可能感觉有点简陋。因此,尝试向 HTML 文档添加一些简单的样式,为文档添加一点活力,并使文档更清晰、更易于阅读。

无图
52 www.52nlp.cn / 2022-12-10 22:41

智能文档处理IDP关键技术与实践-高翔

什么是智能文档处理?针对文本数据处理尤其是纯文本,大家通常会想到使用自然语言处理(Natural language processing,NLP)技术来解决语义理解及分析处理工作。关于自然语言处理技术的研究有很长历史,针对不同层面文本处理和分析有很多技术点,常见技术例如分词与词性标注、命名实体识别、句法结构分析、文本分类、文本摘要等功能。

无图
mp mp.weixin.qq.com / 2022-05-15 09:52

谨慎!糟糕程序员的编程风格查看

有一种说法是,“一个伟大的程序员相当于10个平庸的程序员”。
没有人愿意被贴上了糟糕程序员的标签,但一个可悲的事实是,很多开发人员没有意识到他们自己就属于这一群体。没有人愿意问自己:我是一个糟糕的开发人员吗?

无图
mp mp.weixin.qq.com / 2022-04-05 22:04

一名Vue程序员总结的React基础

我已经把这张图印在脑子里面了,没事就自己画画,中间发散一些自己的思考。u1s1,不知道 react 的生命周期命名为什么要怎么长~~~, 小程序,vue 的都比较短。毕竟使用的频率还是很高的,Hooks 除外。

无图
mp mp.weixin.qq.com / 2022-04-05 22:03

最受程序员欢迎的20本书!

这本书实际上是两本书合二为一,第一部分是一个关于开发企业应用程序的简短教程,你可以从头到尾阅读该教程,以了解本书教程的范围。第二部分,即本书的重点,是对模式本身的详细参考。个模式都提供使用和实现信息,以及Java或C#中的详细代码示例。整本书还用UML图进行了丰富的说明,以进一步解释这些概念。

无图
mp mp.weixin.qq.com / 2022-03-24 09:21

这5个程序员,改变了世界!

从 1 和 0 开始,编程经历了很长一段路,才达到了现在的抽象状态。过去的程序员用伟大的发明,为现代程序员轻松地完成工作奠定了坚实的基础。如果我们研究某个软件,也许,它是在若干个库的帮助下编写的,而这些库又有另一套多年前创建的依赖关系。

无图
mp mp.weixin.qq.com / 2022-02-13 22:19

Java程序员常犯的10个SQL错误!

Java程序员编程时需要混合面向对象思维和一般命令式编程的方法,能否完美的将两者结合起来完全得依靠编程人员的水准:

技能(任何人都能容易学会命令式编程)
模式(有些人用“模式-模式”,举个例子,模式可以应用到任何地方,而且都可以归为某一类模式)
心境(首先,要写个好的面向对象程序是比命令式程序难的多,你得花费一些功夫)

无图