documentation

ソフトウェア関連, 「技術文書の書き方」

技術文書の書き方 リンク よく書かれる文書の種類 README.md Design Docs 設計文書。 最低限書かれること。 - 解決したい課題とその背景 - 実装することになる予定の機能 - 実装方針 参考:googleでのDesignDocsの書き方 Specifications / API docs 仕様書。…

Markdown - 目次の作成方法

vscodeのMarkdown All in Oneを使用 Markdown All in One 見出しの作成方法 コマンドパレットからMarkdown All in One: Create Table of Contentsで見出し作成 更新 編集後、保存すると見出しも更新される。 セクション番号の追加/削除 コマンドパレット -> …

pandoc - 使用例

Markdown -> html Markdownファイルをhtmlに変換する Latexを含むMarkdownファイルをhtmlに変換する。 Markdown -> docx References Markdown -> html Markdownファイルをhtmlに変換する pandoc test.md -f markdown -t html -o test.html Latexを含むMarkdo…