設計ドキュメント腐る問題、Git管理で運用してみた結果 | フューチャー技術ブログ
はじめにTIG真野です。 秋のブログ週間2023 の3本目は、設計ドキュメントをGit管理して腐らせないようにがんばってみた話をします。 前段として6年前、「我々はいかにシステム開発におけるドキュメント腐る問題と戦えば良いのか」という記事を書いたのですが、その後の試行錯誤はどこにも残していないことに気づきました。普段のフューチャー技術ブログですとちょっと引け目を感じるテーマですが、秋の夜長を楽しむため読み物成分を多めに書くというテーマのこのブログリレーにピッタリな気がするため、この機会をお借りします。 ドキュメントも色々な種別があるかと思いますが、この記事では設計ドキュメントを指すことにします。設計ドキュメントは開発メンバーが参照するもので、ステークホルダーへの説明資料に引用して使うことはあれど、主目的は異なるという前提です。Design Docの場合もありますし、システム構成図、ERD、
Craft – The Future of Documents
If you’re looking to restore (or introduce) a little order to your life, Craft will fall somewhere between “immediately helpful” and “enough to bring a tear to your eye.” This productivity app is so versatile that it’s hard to define: It’s for taking notes, writing to-do lists, organizing important documents, organizing unimportant documents, stashing away random scraps and, ultimately, transformi
すべての社内文書はMarkdownで書けばいいと思うこれだけの理由 - Qiita
Markdownを社内に布教したい、というモチベーションからMarkdownを勧める理由をまとめたもの。 同じようなことを考える方へ、周囲への説得材料になると嬉しい。 1. Markdownを勧める理由 1-1. 圧倒的理由 全人類がマークダウンを学習すべき理由｜情報デザイン力を鍛えよう Markdownとは (日本語Markdownユーザー会) をMarkdownで引用する。 Markdown（マークダウン）は、**文章の書き方**です。 デジタル文書を活用する方法として考案されました。特徴は、 - 手軽に文章構造を明示できること - 簡単で、覚えやすいこと - 読み書きに特別なアプリを必要としないこと - それでいて、対応アプリを使えば快適に読み書きできること などです。 Markdownはジョン・グルーバー（John Gruber）によって2004年に開発され、 最初は [Darin
行政文書をマークダウン化しよう！ところでマークダウンって何？｜METI-DX 経済産業省DXオフィス
最初に見つけたのがこのユーザー会さんのページです。こちらにマークダウンとは「文章の書き方」とあります。なるほど簡単。軽量マークアップ言語よりは、かなり柔らかくなりました。ただ、むしろ簡単になりすぎて今度は具体的なイメージが沸かないか？ 次に見つけたのは、こちらのブログです。 ここでは、「手軽にドキュメントを装飾できるフォーマット」とあります。うんうん、なんとなくイメージしている説明に近づいてきました。 そして最後に見つけたのが https://wa3.i-3-i.info/word16753.html 単なる「ファイルの書き方ルールの１つ」ですよと。これですかね。 人間社会に「日本語」「英語」「ドイツ語」などの様々な言語があるように、デジタル世界でも、HTMLとかXMLとかPDFとか、いろいろな言語(ファイルの書き方ルール)がある、そのうちの１つがマークダウンという言語。それ以上でも以下で
ExcelやGoogleスプレッドシートをMarkdown出力するVS Codeの拡張機能「Excel to Markdown table」が便利すぎる件 | DevelopersIO
Markdownでテーブルを表現するにはつらみが深すぎる みなさんはMarkdownでテーブルを書くことは得意ですか? 私は苦手です。 簡単なテーブルは簡単に書けるのですが、以下のようなテーブルを書くことには抵抗感があります。 行数、列数が多い セル内に書くテキスト量が多い セル内でリストを表現する 一方、私は先日、「Markdownで手順を書いています!」とこちらの記事で伝えました。 そんな私に対して、 「オイオイオイ。 Markdownでもなんでもいいけどよォ... テーブルを使いたい場面は多いんだぜ。」 というセリフが聞こえてくる気がします。 私のようなMarkdownでテーブルを書くことにつらみを覚える方への解決策として、以下記事で紹介している「MarkdownTableMaker」があります。 このアドオンを使うことで、選択したスプレッドシートをMarkdownに出力してくれます
VSCode + Markdownでスライドや書籍も書いちゃおう！ - Qiita
はじめに Markdownって便利ですよね？ README.md、PR や Issue の本文やコメント、Qiita や Zenn はもちろん、Google Docs や Trello や Notion や Jupyter Notebook でも使えるみたいです。もっといろいろな文書を Markdown で書ければいいのになあ、あらゆる文書のソースコードを Markdown にできればいいのになあ。 さあ、Markdown の可能性を広げましょう！ 本記事では「スライド」と「(電子)書籍」をMarkdownで書く方法をご紹介したいと思います。もちろん、VSCodeでMarkdownを効率よく便利に書いていくためのチップスもご紹介していきますよ。 ご参考スライド VS Code Conference Japan 2021 で発表した際の以下スライドもご参照ください。 もちろんこのスライドもV
StackEdit – In-browser Markdown editor
Rich Markdown editor StackEdit’s Markdown syntax highlighting is unique. The refined text formatting of the editor helps you visualize the final rendering of your files. WYSIWYG controls StackEdit provides very handy formatting buttons and shortcuts, thanks to PageDown, the WYSIWYG-style Markdown editor used by Stack Overflow. Smart layout Whether you write, you review, you comment… StackEdit's la
markdownlint - Visual Studio Marketplace
Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter. markdownlint Markdown/CommonMark linting and style checking for Visual Studio Code Introduction The Markdown markup language is designed to be easy to read, write, and understand. It succeeds - and its flexibility is both a benefit and a drawback. Many styles are possible, so formatting can be inconsistent. Some cons
Markdown All in One - Visual Studio Marketplace
Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter. Markdown Support for Visual Studio Code All you need for Markdown (keyboard shortcuts, table of contents, auto preview and more). Note: VS Code has basic Markdown support out-of-the-box (e.g, Markdown preview), please see the official documentation for more information. Table of Contents Features Keyboard shortcuts T
【2024年版】Markdown(マークダウン)エディタ厳選まとめ＜Win/Mac/iOS/Android＞
こんにちは。マニュアル作成・ナレッジ共有ツール「NotePM」ブログ編集局です。 Markdown(マークダウン) とは、文章を記述するための軽量マークアップ言語です。プレーンテキストに対して「# 見出し」「* 箇条書き」などの文書構造を明示し、MarkdownエディタでかんたんにHTML生成することができます。 今回は、無料で使えるオススメのMarkdownエディタを厳選！ Windows/Mac/スマホアプリ対応している定番＆人気エディタを、おすすめポイントと合わせてご紹介します。ブラウザ専用のオンラインMarkdownエディタについては、以下の記事を参照ください。 参考： 【ブラウザ専用】オンラインMarkdownエディタ おすすめ4選 【便利ツール】MarkdownテーブルをExcelライクな操作で簡単に作成できるツール Markdownとは そもそもMarkdownとは、どのよう
Markdown表テーブル作成ツール | NotePM
はじめに MarkdownテーブルをExcelライクな操作で簡単に作成できるツールです。Excel（Googleスプレッドシート）やMarkdown記法で書いたテーブルデータも読み込み編集できます。 本ツールの不具合やご要望をお待ちしております https://help.notepm.jp/hc/ja/requests/new Markdown表テーブル作成ツールの使い方 ExcelまたはMarkdownから読込 1. [データ読み込み] ＞ [Excelからコピペ] または [Markdownテーブルからコピペ] をクリック →ポップアップ画面が表示されます 2. データをコピペして[挿入]をクリック →テーブルにデータが反映されます 行追加、列追加 1. 追加したい列・行の[○]アイコンにカーソルを合わせ、[+]アイコンをクリック →行・列が追加されます 行削除、列削除 1. 追加した
CommonMarkの仕様とか - Qiita
CommonMarkとは Markdownの仕様が全然決まってないのにキレた人達で作った軽量マークアップ言語 Github Flavored Markdownで良くない？ 大本のMarkdownそのものはもう仕様が決まることはない CommonMarkは仕様を決めることがメイン、拡張はまた別の話 CommonMarkが標準になって、GFMがGFCになるのが理想的 具体的なCommonMarkの仕様は？ CommonMark Spec(2016/11/18時点の最新はver.0.27) 書き方の仕様をメインとして、細かな解釈とか内部仕様以外を以下に挙げる ついでにBoostnoteでの解釈が違う場合はその仕様も載せる（自分用） Google翻訳と英単語拾って読んでるので色々間違ってるかもしれない 項番はCommonMark Specと一致しない 1. タブ Tab、または半角スペース4つでコ
CommonMark
A strongly defined, highly compatible specification of Markdown What is Markdown? It’s a plain text format for writing structured documents, based on formatting conventions from email and usenet. Learn Markdown in 60 Seconds Who created Markdown? It was developed in 2004 by John Gruber in collaboration with Aaron Swartz. Gruber wrote the first markdown-to-html converter in Perl, and it soon became
Boostnote | Boost Happiness, Productivity, and Creativity.
Write overviews of systems including concepts, terminology definitions and description of how these concepts work together. Having a 'living document' to help drive dialogue and exchange of ideas through collaboration helps this process significantly. Organize your dev team's sprint backlog and visualize them with status, assignees, reviewers, due date and everything you need. Reduce repeated prog
エンジニアのための十徳ナイフ「DevToys」が便利すぎる - Qiita
DevToysとは デベロッパーのためのスイスアーミーナイフの紹介文の通り。 開発時によく使うツールを十徳ナイフのようにまとめたアプリになっています。 JSONの整形とかエンコードデコードetc... プログラミングや保守運用の調査でやりがちな作業をいちいち変換サイトを探したり、エディター拡張機能のショートカットを探したりせずとも、これ一つですぐにできます！ インストール Microsoft Storeからインストールできます。 公式サイトからストアへのリンクを踏むか、ストア検索して見つけてください。 WinGetやChocolateyでもインストール可能です。 Microsoft StoreアプリなのでWindowsでしか使えませんが、Macユーザーの方は気を落とさずにこちらの記事をどうぞ！ また、作者曰くMacにはDevBoxやDevUtilsなどの類似ツールが既にあるため非対応だそう
自己流の手順書フォーマットを公開してみた | DevelopersIO
手順書フォーマットは千差万別 みなさんは自己流または、組織やプロジェクトで定められた手順書のフォーマットはありますか? 私は自己流の手順書フォーマットがあります。 自己流の手順書フォーマットがあるといっても、かなり扱いがふわふわしているので、備忘やメモの意味合い強めでまとめていきます。 「もっとこうした方がいいよ!!」などフィードバックがあれば、ぜひお願いします! いきなりまとめ 手順書はExcelやスプレッドシートではなく、Markdownで書く 手順書はgitで管理する 5W1Hを意識して手順書を書く 基本的にはCLIを使った手順書にする 手順書はExcelやスプレッドシートではなく、Markdownで書く 手順書をExcelやスプレッドシートで書くメリット・デメリット 手順書をExcelやスプレッドシートで書いている方も多いと思いますが、私はMarkdownで書いています。 Exce
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
linguist/lib/linguist/languages.yml at master · github-linguist/linguist
Visual Studio Code＋Markdownでキレイなプレゼンスライドを手軽に作成できる「Marp」／Markdownに慣れているのならばちょっとした拡張記法を覚えるだけ【レビュー】
Googleのデザインドックのマークダウンサンプルらしい
StackEdit