foodogsquared/website
1
0
Fork 0
mirror of https://github.com/foo-dogsquared/website.git synced 2025-02-07 09:19:00 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

UPDATE: What is effective documentation

Browse Source
This commit is contained in:
foo-dogsquared 2019-09-30 01:37:56 +08:00
parent a51e672ba1
commit 8a90aaf934
2 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
content/posts/images/the-importance-of-technical-writing-and-typography-in-a-software-project/latex-lecture-layout.webp
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 31 KiB

After

Width:  |  Height:  |  Size: 31 KiB

4
content/posts/what-is-effective-documentation.adoc
View File

@ -109,7 +109,7 @@ To get us in the same page, here's the list of software I reflected and inspecte
* https://reactjs.org/[ReactJS]
Anyhow, I try to answer the million-dollar question.
I put it in two lists: one for the content and one for the typography.
I put the answers in two lists: one for the content and one for the typography.
=== Common attributes of documentation content
@ -159,7 +159,7 @@ Even for a small project, making effort to plan is heavily appreciated.
In my case, I created a document structure for my project.
Create a README and the `docs/` folder for assets (e.g. images, videos).
I also created a standard template for my README: the abstract, purpose, getting started guide, details, and the license.
You can see more of the details in my [project template documentation].
You can see more of the details in my https://github.com/foo-dogsquared/personal-style-guides/blob/master/src/projects.adoc[project template documentation].
=== Document only the big things