程序員寫(xiě)技術(shù)類的書(shū)籍,應(yīng)該偏向于教程。
假設(shè)你寫(xiě)一個(gè)教程教小白如何編程。
首先" />
更新時(shí)間:2021-06-11 03:59:32作者:admin2
首先我不是程序員,但酷愛(ài)讀書(shū),對(duì)書(shū)籍的寫(xiě)作有個(gè)大體思路。我說(shuō)說(shuō)自己的看法,希望對(duì)你有幫助。
程序員寫(xiě)技術(shù)類的書(shū)籍,應(yīng)該偏向于教程。
假設(shè)你寫(xiě)一個(gè)教程教小白如何編程。
首先你要說(shuō)明白為什么要學(xué)編程,編程有什么好處。
人們的大腦更容易對(duì)故事作出反應(yīng),建議不要乏味的去闡述這件事情,用講故事的方式告訴大家原因,以及學(xué)習(xí)編程的好處。也就是,學(xué)會(huì)編程你能得到什么?參考書(shū)籍:《故事思維》。
之后最好結(jié)合你本人的學(xué)習(xí)經(jīng)歷,走過(guò)哪些彎路,總結(jié)出什么好方法。按照你自己的思路,循序漸進(jìn)的引導(dǎo)讀者進(jìn)入狀態(tài)。
這是我給你提供的思路。畢竟我不是程序員,具體技術(shù)環(huán)節(jié)沒(méi)法亂說(shuō)。
但大體思路不會(huì)錯(cuò)。
你可以先整理出大綱,需要什么素材資料,先去收集。之后動(dòng)筆,會(huì)事半功倍。
技術(shù)文檔有很多類,比如:方案概要設(shè)計(jì),硬件方案設(shè)計(jì),結(jié)構(gòu)方案設(shè)計(jì),軟件方案設(shè)計(jì),研發(fā)調(diào)試文檔記錄,試驗(yàn)記錄,變更單等都是技術(shù)文檔。每一個(gè)都有一定格式和重點(diǎn)。和處在的階段不一樣寫(xiě)的不一樣,一般要有目錄,概要,背景,技術(shù)指標(biāo),功能,性能,電氣要求,防護(hù)要求,端口定義,圖示等內(nèi)容,參考標(biāo)準(zhǔn)等。