Modern software documentation

Write markdown pages. Use a tool such as Visual Studio Code

Push via wiki, such Docusaurus

Using the same version/source control, such as Github

• Check-in/out for concurrent updates
• Versioning for comparison over time

Documentation is part of the product

A product has the lifecycle:

• Request via Jira
• Assign to an owner/creator
• when doc resource is a constraint, prioritize them
• Reviewed by PM, DEV
• Verified by QA
• Release via publishing
• Change/Correction, Enhancement via Jira

Text Editors on Mac OSX

I used Text Mate and TextWrangler.  Both are excellent.  They are not really free and I do not want to have any license risk by using an unlicensed version for work.

I recently found a new alternative. 

Git is Awesome!

A good work: Common Use cases of Git and Github.

Git Large File Storage

Git Large File Storage (LFS) replaces large files such as audio samples, videos, datasets, and graphics with text pointers inside Git, while storing the file contents on a remote server like GitHub.com or GitHub Enterprise.

After installing, run this command:

git lfs track FILE_PATH

See what happens inside Git

Here is an excellent article:

Git and Github work together

1. Create a GitHub repository
2. Clone the repository to a local directory
3. Work on your local repo, such as modifying or adding files
4. Use 'git add' to add intended files to the local repo
5. Use 'git commit -m to commit the changes
6. Push local data to the remote location (GitHub)

By cloning the repository, a local repo will be initiated.
If you make changes directly via GitHub, there could be mismatch between the local and the remote repo.  You can use the pull command to merge the changes.

A good introduction to Git

Github and Git

Github.com is a website that hosts many software development projects.  It is kind of like a collaboration workspace. It can host files, but it is mainly for maintaining the software codes.

Git is a software that provides the version control service.  You can keep the old versions and track the changes.  It provides a multi-user development (MUD) environment.  You will know who makes the changes and when the changes are made.

Here is a great video:

Git Repository

If you are using Github, creating a Git repository means that creating a space in the Github site for storing the files.

If you are using Git locally, creating a Git repository means enabling the features of Git, such as version control.

Things to do after installing Git

Typically the tutorial starts with teaching these commands:

git init 
git add
git status
git commit
git log

Like this TryGit tutorial from Code School.  Unless you are doing development work, these may not be useful for you.

A powerful and useful command is to copy the entire directory and files from a repository from Github.

Getting started with Git

Why do I need to learn Git?

Github is used for

• sharing files
• wiki
• issue tracking
• backup

It is used in many open source development.
It is used by the course I am taking from Coursera.com.

Git is the version control software to interact with Github.

Where did Git come from?

It was designed for managing Linux development. It is a distributed development environment.

Where to download Git?

Official site: git-scm.com
We can download GIT from here.

What does the Git Bash software do?

Created my first Github repository

Just followed the instruction here:
https://guides.github.com/activities/hello-world/

Learning Github and Git is a very good way to learn these basic idea about software development :

1. Version Control