[B! markdown][document] kenjiro_nのブックマーク

GitHub+VSCodeでのMarkdownドキュメンテーションのプロジェクトルールを考える

概要 Word や Excel でのドキュメント作成を回避し、なるべく生産性高く、かつ、OS 環境依存なく、すべて基本無料で構成できるツールで、Markdown ベースで設計書を作成することを考えてみます。 GitHub 上で閲覧できる形でドキュメントを作成することを前提に、VSCode（＋プラグイン）を用いて、テキスト文書、表（テーブル）、図（構成図など）、キャプチャ、などをスピーディに作成し、PullRequest ベースで運用していけるように、プラグインを構成および、レギュレーションを作成してみました。 GitHub の README.md や Wiki に書いて使えるかと思いますので、併せて markdown 形式および、vscode のプラグイン推奨設定ファイル形式でも載せておきます。もし、もっとこのプラグインを使うと良い、などアイデアなどありましたら教えていただけると幸いです

kenjiro_n 2022/08/16

リンク

プロジェクトの各種ドキュメントをExcelではなくMarkdownで作ってみた - 聞こえないJavaエンジニアが適当に書き連ねていく

これは何プロジェクトの知見共有や手順書を共有する時に、Excelではなくてmarkdownで書いたWebsiteを使ったことの振り返り。注意 Excelを全く使わなかったのではなく、主な資料をExcelではなくてWebsiteにした。補助資料をExcelで作ったものもある。なぜExcelにしなかったのか過去のプロジェクト経験を基にExcelを使うことのメリットとデメリットを比較した時、Excel以外の方法を試してみる価値はあると考えた。 Excelのメリット画像の貼り付けや吹き出しの付与が簡単文字の装飾が簡単印刷することを想定しなければ、見た目を整えるのが非常に楽 Excelのデメリットファイルをどこに置いてあるか探しにくいファイル内部の文言検索がやりにくい画像を大量に貼り付けるとファイルサイズが大きくなる修正した時、差分の確認がほぼ不可能 Markdownで資料を作

kenjiro_n 2020/09/03

リンク

Excel設計書を抹殺したくて4年前にWiki設計書を導入したら、意外とちゃんと開発回ってた話。 - Qiita

初めましてこんにちは。最近コードレビューの記事書いたら、Excelベースだったことを理由に Qiitaコメントとはてブで徹底的に燃やされたおじさんです。いやね、僕だって使いたくて使ってるわけではなくてね、できることなら使いたくないんですよ。というわけで名誉挽回のために脱Excelできた話、それも日本の三大悪三大風習に数えられるExcel 設計書を抹殺した話を書きます。 (2/25修正：悪は言いすぎました。訂正します。） Growi 最高。またの名をExcel方眼紙。エクセルのセルの縦横を同じくらいの大きさに調整し方眼紙のようにして、そこに設計書として文字と図と表を記載する方式。メリット一つのファイルに文字と図と表がまとめて記載できるテキストでは文字は書けても図と表が書けない Wordでは、文字と図表エリアとを2列表示するのが難しいできなくはないが面倒くさい UMLモデ

kenjiro_n 2020/02/24

Growiの紹介。

リンク

Markdown と GitHub で社内規程を便利に管理 - クックパッド開発者ブログ

VP of Techno logy の星 (@kani_b) です。技術基盤や研究開発領域などを担当しつつ、社内の色々なことを技術の力でいい感じにする仕事をしています。セキュリティや AWS の話が好きです。さて、みなさんは、ご自身が勤務する会社の就業規則を読んだことはあるでしょうか。エンジニアに限らず、会社の全スタッフが仕事をする上で関わってくるのが、就業規則や情報セキュリティドキュメントなど、会社のルールや規程を記す文書です。特にセキュリティやインフラに携わるエンジニアは、その改訂も含め携わったことがある方もいるのではと思います。よくある文書管理こうした文書は、以下のように管理されていることが多いようです。ベースドキュメントは Word 保存時は PDF で保存版管理は Word の編集履歴 + PDF に保存する際のファイル名編集は担当部門, 担当者のみが行うかつての