Log in
My Tools
Shell (Sow)
Shell (Guacamole)
Shell (Tabby)
Code Explorer
Matrix Chat
My Web Server
My Digital Portfolio
My IGIS
Proficiency Progress
Sash Awards
CEG-ID
Keys and Commands
Guacamole Keys
Emacs Keys
Magit Keys
Screen Keys
LLDB Commands
Overviews
Experiences Overview
Experiences Explorer
Topic Explorer
Curricula Assistant
Trailblazers
References
Swift Live Reference
Glossary
Common Errors
References
Code Snippets
Navigation
Experiences Overview
Google
Special Users
Authors
Guides
Tools
What links here
Related changes
Special pages
Printable version
Permanent link
Page information
Browse properties
Why Writing Great Documentation Is Essential
From Coder Merlin
Revision as of 09:57, 3 December 2021 by
Rebecca-weng
(
talk
|
contribs
)
(
→References
)
(
diff
)
← Older revision
|
Latest revision
(
diff
) |
Newer revision →
(
diff
)
Jump to:
navigation
,
search
Within these castle walls be forged Mavens of Computer Science ...
— Merlin, The Coder
Coming Soon
Article about why writing great documentation is essential.
Contents
1
Introduction
2
Different Kinds of Documentation
3
Reading Documentation
4
Writing Your First Documentation
5
Steps to Improve Documentation
6
Key Concepts
7
References
Introduction
[
edit
]
Different Kinds of Documentation
[
edit
]
Reading Documentation
[
edit
]
Writing Your First Documentation
[
edit
]
Steps to Improve Documentation
[
edit
]
Key Concepts
[
edit
]
References
[
edit
]
https://www.altexsoft.com/blog/business/technical-documentation-in-software-development-types-best-practices-and-tools/
https://cds.cern.ch/record/383260/files/p135.pdf
https://www.sitepoint.com/writing-software-documentation/
https://www.geeksforgeeks.org/overview-software-documentation/
https://www.facebook.com/Coder-Merlin-101592328319584/
https://teespring.com/stores/coder-merlin
https://twitter.com/codermerlin
https://discord.gg/Hj7mTVtMbH
https://discourse.codermerlin.com/
https://openbadges.org/
Designed with pride in Silicon Valley, CA, USA
