Skip to content

Commit ad75862

Browse files
committed
Add more resources
1 parent 203a1f9 commit ad75862

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README.md

+8-4
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ This list aims to assist by providing you with out-of-box templates and practica
4747

4848
### User Documentation
4949

50-
> It doesn't matter how good your product is, because if its documentation is not good enough, people will not use it. - [The Documentation System](https://documentation.divio.com/introduction.html)
50+
> _"It doesn't matter how good your product is, because if its documentation is not good enough, people will not use it."_ - [The Documentation System](https://documentation.divio.com/introduction.html)
5151
5252
#### Tutorial
5353

@@ -87,7 +87,7 @@ Answers frequently asked questions to quickly resolve common issues or clarify t
8787

8888
#### In-app Documentation
8989

90-
Wizards, tooltips, onboarding, etc.
90+
Assist users in understanding and navigating the features and functionalities of the app directly from within its interface.
9191

9292
- [Driver.js](https://github.com/kamranahmedse/driver.js) - A light-weight, no-dependency, vanilla JavaScript engine to drive the user's focus across the page.
9393
- [Shepherd](https://github.com/shepherd-pro/shepherd) - Guide your users through a tour of your app.
@@ -126,7 +126,7 @@ Wizards, tooltips, onboarding, etc.
126126

127127
### API Documentation
128128

129-
API is the univesal language of the software world, which needs to be documented well.
129+
> _"All teams will henceforth expose their data and functionality through service interfaces."_ - [The Bezos API Mandate](https://nordicapis.com/the-bezos-api-mandate-amazons-manifesto-for-externalization/)
130130
131131
#### General
132132

@@ -194,7 +194,11 @@ API is the univesal language of the software world, which needs to be documented
194194

195195
#### Comments
196196

197-
> “Code Tells You How, Comments Tell You Why.” — [Jeff Atwood](https://blog.codinghorror.com/code-tells-you-how-comments-tell-you-why/)
197+
> _“Code Tells You How, Comments Tell You Why.”_[Jeff Atwood](https://blog.codinghorror.com/code-tells-you-how-comments-tell-you-why/)
198+
199+
- [Best practices for writing code comments](https://stackoverflow.blog/2021/12/23/best-practices-for-writing-code-comments/) - 9 rules to help you write better comments, providing examples and explaining how and when to apply them.
200+
- [The Engineer's Guide to Writing Meaningful Code Comments](https://stepsize.com/blog/the-engineers-guide-to-writing-code-comments) - Covers types of comments, when and how to write code comments, some best practices, and when not to write them.
201+
- [NERD Commenter](https://github.com/preservim/nerdcommenter) - Vim plugin for intensely nerdy commenting powers.
198202

199203
#### Error Messages
200204

0 commit comments

Comments
 (0)