Skip to content

Documentation session #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 15 commits into
base: master
Choose a base branch
from
Open

Documentation session #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
a9b9c70
Add first draft: How to Write Documentation
Jun 27, 2019
e6edff6
Fix formatting
Jun 27, 2019
1e6c1ac
Fix Formatting
Jun 27, 2019
5ec35d2
Add Python Doctest reference to the software_docuemntation
Jun 27, 2019
fba0d00
Add section on Agile Methodologies
Jul 1, 2019
51e040c
Add ticket system and work unit (commit log)
Jul 1, 2019
f8e5f9e
Add the properties of the good documentation
Jul 1, 2019
44aaa6f
Give examples of the Single Source of Information
Jul 1, 2019
8001caf
Review some style and grammar of the document
Jul 1, 2019
6a467e3
Review more style and grammar of the document
Jul 1, 2019
5295c3b
Captitalize the titles
Jul 2, 2019
004e421
Remove tip of the day
Jul 2, 2019
ae954be
Fix formatting
Jul 2, 2019
2916b85
Add links to README.md examples
Jul 3, 2019
12f9209
Change the title (add pronoun)
iamwrong Jul 8, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,16 @@
# knowledge_sharing


On this repository you will find several articles worth reading and
spreading.

Some of them were written to share knowledge with other people, others
were just written as a reminder to myself (i use them as extension for my
memory and reference).

# Articles

[How to write good documentation]

[How to write good documentation]: software_documentation/README.md

Loading