[爆卦]markdown檔案是什麼?優點缺點精華區懶人包

雖然這篇markdown檔案鄉民發文沒有被收入到精華區:在markdown檔案這個話題中,我們另外找到其它相關的精選爆讚文章

在 markdown檔案產品中有6篇Facebook貼文,粉絲數超過2,850的網紅矽谷牛的耕田筆記,也在其Facebook貼文中提到, 今天的文章不是一個技術文,反而是探討身為一個軟體工程師,該怎麼撰寫相關的技術文件 鑑於 WFH (Work From Hoem) 習慣的興起,人與人面對面的溝通減少,這意味即時的訊息傳遞變少了,取而代之的是非同步的訊息傳遞,簡單來說就是技術文件。 好的技術文件能夠讓需要的人快速找到問題,解決疑惑...

markdown檔案 在 輯輔 Instagram 的精選貼文

2020-09-07 20:47:07

⠀⠀⠀⠀ 《 #NOTION 使用 #心得 #分享會 :#筆記 整理 》 大家如果有興趣,可以直接到我的連結點選「NOTION常用語法清單」,進去後直接複製(duplicate)到自己的帳號做使用喔~ 時間:8/22 (六) 10:00 ~ 11:30 NOTION是一套主打「ALL IN O...

  • markdown檔案 在 矽谷牛的耕田筆記 Facebook 的最佳貼文

    2021-02-03 09:00:12
    有 91 人按讚

    今天的文章不是一個技術文,反而是探討身為一個軟體工程師,該怎麼撰寫相關的技術文件

    鑑於 WFH (Work From Hoem) 習慣的興起,人與人面對面的溝通減少,這意味即時的訊息傳遞變少了,取而代之的是非同步的訊息傳遞,簡單來說就是技術文件。

    好的技術文件能夠讓需要的人快速找到問題,解決疑惑,但是一個好的技術文件到底該怎麼寫,這部分其實非常困難,並不是向程式碼一樣可以 copy&paste 馬上看到成果的,反而是需要時間練習,將整個過程與思路消化起來,用自己習慣的語言與形式將其撰寫出來。

    首先,作者非常推崇由 Google 撰寫的系列文章,Tech Writing Course,整個課程內容不到兩小時,從不同章節來跟大家分享如何撰寫技術文章

    接者撰寫技術文章時,作者個人是喜歡 divio 這個平台,不過更重要的則是其推薦的分類模式,根據內容分類成四大項

    1. Tutorials - 學習導向
    2. How-To Guides - 問題解決導向
    3. Explanation - 深度理解導向
    4. Reference - 資運分享導向

    Google: https://developers.google.com/tech-writing
    Divio: https://www.divio.com/

    最後寫作語法方面,作者認為寫出一個能夠被有效搜尋的文章是非常重要的,譬如透過 word 等方式上傳檔案到系統中反而是一個不利於搜尋的方式。
    取而代之的是,作者認為可以採用 Markdown 類似的語法作為基礎去撰寫文章,這種方式對於維護與撰寫都相對容易

    今天有任何 Diagrams 的畫圖需求,可以考慮使用 Mermaid 這套解決方案,對於 GitLab/Azure 的使用者來說,已經內建其中。 GitHub/Atlassian Confluence 則有相關的 Plugin 可以安裝使用

    最後則是文章的樣版內容,針對特定的文章格式,已經有不少的範本可以參考,透過這些範本可以更清楚的去描述你的內容,讓整體文章看起來更佳簡潔與流暢

    1. Software Architecture Review Template
    2. Architecture Decision Record Template
    3. Incident Postmortem Template
    4. DevOps Runbook
    5. Decision Template
    6. Writing Guidelines
    7. OKR Template
    8. Etc.

    有興趣的點選原文學習更多
    https://medium.com/better-programming/best-practices-when-documenting-your-code-for-software-engineers-941f0897aa0

  • markdown檔案 在 軟體開發學習資訊分享 Facebook 的精選貼文

    2020-10-25 14:32:49
    有 7 人按讚

    一個易於使用的部落格平台,支援 Jupyter Notebooks、 Word 檔案和 Markdown。

    可以直接從 Jupyter Notebook 建立包含程式碼,程式碼輸出(可以是互動式的),格式化文字等的發文

    🔥 開源報報週年慶,即日起到 11/5 訂閱,加贈 3 個月 ( https://softnshare.com/subscriptions/ )

    https://softnshare.com/jupyternotebooks-to-blog/

  • markdown檔案 在 軟體開發學習資訊分享 Facebook 的最讚貼文

    2020-06-11 07:08:59
    有 14 人按讚

    今天的開源報報( 每週一到週五早上7:00準時發刊)

    今日內容摘要

    ✅ 用於打包、傳送、儲存和交付內容的Docker 工具箱
    ✅ 用於.NET Core 和.NET Core工具的 Docker 映像檔
    ✅ PHP 靜態分析工具——發現程式碼中的錯誤而不執行它
    ✅ 一個避免讓你的電腦進入睡眠模式的簡單應用程式
    ✅ 紀錄被任何 Linux 行程所訪問的檔案
    ✅ 一個加密的儲存系統,它提供了一個由雲端儲存支援的使用者友好的 FUSE 磁碟
    ✅ 針對開發人員所開發的高度可客製化終端儀表板
    ✅ 以 React 和 Prosemiror 為基礎的 Markdown 編輯器
    ✅ 具有原生介面感覺的 HTML 觸控滑動旋轉器
    ✅ 開源的自我託管電子郵件行銷。以很小的成本管理你自己的時事通訊
    ✅ 一個時間變化圖形資料的版本化資料儲存
    ✅ 針對電腦視覺的資料集、轉換和模型
    ✅ 一個滲透測試框架/駭客工具套件
    ✅ 自動化可擴充的 PaaS 套件(自動化 Docker + nginx)
    ✅ 重寫 ngxtop 工具
    ✅ 一個使用 Swift 實現的標準和安全的密碼演算法集合
    ✅ 一個最小化和記憶體高效的 Python 實現 – 適用於桌面、雲端、受限制的系統、微控制器以及所有的東西
    ✅ 為程式新增一個命令提示符,以及 telnet 訪問
    ✅ 針對滑雪/登山/滑翔者可客製化的開放 GPS 無線電網格裝置程式碼

    https://softnshare.com/opensource-news-144/

你可能也想看看

搜尋相關網站