You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+8-4
Original file line number
Diff line number
Diff line change
@@ -47,7 +47,7 @@ This list aims to assist by providing you with out-of-box templates and practica
47
47
48
48
### User Documentation
49
49
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)
51
51
52
52
#### Tutorial
53
53
@@ -87,7 +87,7 @@ Answers frequently asked questions to quickly resolve common issues or clarify t
87
87
88
88
#### In-app Documentation
89
89
90
-
Wizards, tooltips, onboarding, etc.
90
+
Assist users in understanding and navigating the features and functionalities of the app directly from within its interface.
91
91
92
92
-[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.
93
93
-[Shepherd](https://github.com/shepherd-pro/shepherd) - Guide your users through a tour of your app.
@@ -126,7 +126,7 @@ Wizards, tooltips, onboarding, etc.
126
126
127
127
### API Documentation
128
128
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/)
130
130
131
131
#### General
132
132
@@ -194,7 +194,11 @@ API is the univesal language of the software world, which needs to be documented
194
194
195
195
#### Comments
196
196
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.
0 commit comments