Getting start文件範本

開發程式常常會遇到要交接程式專案。

之前接手過幾次別人的程式，對方往往把什麼都不懂的狀態的交接的人叫到電腦前面，隨便快速的操作一通，就認為交接完成。事實上，不但來不及學，寶貴的經驗也無法傳承。

所以為了讓接手的人能夠快速上手，不要丟失經驗傳承，也為了不要在要交接給別人時手忙腳亂，我會在平時就寫好 Getting Start 的文件。

目前我寫過的 Getting Start 文件大概都長這樣




1. 用 Microsoft Word 寫，因為可以很方便轉 PDF
2. 範本，假設內容是一個 HelloWorld

HelloWord                << 標示專案名稱
Introduction
    Demo how to print message.  << 說明要幫使用者解決的問題
 

^^^^^ 這邊用程式截圖，贏過幾百字敘述。

Table of Content     << 用 Word 的 自動目錄產生，會有超連結，可以像投影片一樣報告

• Introduction
• System Requirements
• Hardware
• Software
• Tools
• How to Build
• How to Run
• Architecture
• Knowhows

System Requirements
    Hardware

• PC
• 某一種特定的電路板 

    Software

• 軟體1 (version XXXX or later)
• 軟體2 (version XXXX or later)

    Tools

• Microsoft Visual Studio 2015

How to Build

1. Double click Helloworld.sln 
2. click Build > Build Solution

How to Run

1. Press Ctrl+F5

Architecture
   

                                                       ^^^^ 可以用 planttext.com 幫忙產生 UML
Knowhows
    這邊就是經驗傳承，開始一項一項詳細的描述。