技術文書の書き方
howto-tech-docs.md 技術文書の書き方 このメモは、私（@ymmt2005）が長年にわたってソフトウェアプロダクト開発に関わってきて 2022年現在こうしたほうが良いと考えているベストプラクティスです。 科学的な分析等に基づくわけではない経験則であるため、今後も随時見直すことがありますし、 ここに書いてあることが常に正しいわけでもあらゆるソフトウェア開発に適するわけでもありません。 しかしながら、実務経験が豊富で、モダンな技術スタックに明るいエンジニアの経験則は一定の 役に立つのではないかと考えて記します。 技術文書とは ここでは、ソフトウェア開発で技術者が書くべき文書ということにします。 ソフトウェアエンジニアにも役割がいろいろあり、アーキテクトと independent contributor では書く文書が違うということはあるでしょうけれど、ここではごっちゃにします。
gihyo.jp編集部におけるMarkdown記法 | gihyo.jp
本稿では、gihyo.jp編集部で利用しているMarkdownファイルの記述方法を主に解説します。 注意：gihyo.jp編集部内でのみ採用しているMarkdownの書き方をまとめた文書を、記事の体裁を取って公開したものです。なお、記事公開後に記述方法を追加・変更する可能性もあります。 Markdownとは？ はじめに、筆者の把握している範囲でMarkdownについて概説しておきます。 近年は一般向けのウェブサービスやテキストエディタでも利用されてきているMarkdown。端的に言えば、テキストファイル上で文書を書くための構文です。文書の読みやすさに焦点を当てており、Markdown形式のテキストファイル（＝Markdownファイル）をそのまま見れば文書とその構造が理解できるように、Markdown特有の編集記号や字下げを用いて表現します。また、MarkdownファイルをHTMLファイルに
Markdownでシーケンス図とかが書けるMermaid記法で業務フローを書いたら意外とイケたので自分なりのコツを紹介してみる | DevelopersIO
こんにちは、臼田です。 みなさん、業務設計してますか？(挨拶 今回はMarkdownでシーケンス図やフローチャートなどの図を記述できるMermaidを使って業務フローを書いてみたら、意外と書けたので自分なりのTipsを紹介したいと思います。 その前に 注意点として、まだMermaidを使い始めたばかりなので、「もっとこうしたらいいぞ」とか「こっちのほうがいいぞ」とかあれば建設的なフィードバックとしてSNSとかでいただけるとありがたいです。 あと業務フローって表現しましたが、人によって思い描く業務フローが違うと思うので、業務フローの定義に関するツッコミはご容赦ください。私が今回Mermaidで書いたのは以下の図です。(内容はブログ用に簡素化しました) この図のコードは以下のとおりです。(後ほど解説します) sequenceDiagram autonumber actor お客様 partic
Markdown の Table 記法を CSS で実現する | blog.jxck.io
Intro 本ブログは Markdown で原稿を書き、それを HTML に変換して表示している。このとき、 CSS を用いて Markdown のシンタックスに似せた Style を適用している。例えば以下のように h2::before に content: '##' を指定するといった具合だ。 しかし、これまで <table> だけはうまく Markdown 記法を再現する CSS が書けないでいた。 そこで、周りの CSS 強者に実現できないか聞いてみたところ、@shqld, @araya, @yoshiko 達の協力を得て、かなりの完成度にすることができた。実現方法を記録する。 Before 実現したいのは以下のような記法だ。 | file type | size | ratio | |:----------|-----:|------:| | .webp | 9474 | 100
Kobito for Mac / Windowsの提供及びユーザーサポートを終了します - Qiita Blog
Qiita, Qiita:Teamをご利用いただきありがとうございます。 このたびプログラマのための技術情報記録ツール「Kobito for Mac」（2012年4月リリース）及び「Kobito for Windows」（2015年5月リリース）の提供及びユーザーサポートを終了することとしました。（Electron製のKobito OSSは引き続き公開を継続いたします。） 今後の予定2017/12/8：Kobito for MacのMac App Storeでの新規ダウンロードの終了2017/12/27：Kobito for Mac, Windows提供サイトの閉鎖2017/12/27：ユーザーサポートの終了定期購読で Kobito のプレミアムプランをご利用中の方は、現在の定期購読の期間内はプレミアム機能をお使いいただけます。2017年12月8日で定期購読の自動更新は解除されるため、解約
Qiita / Qiita:Team における Markdown レンダリングの歴史
Markdown Night 2017 Summer https://connpass.com/event/63383/
MarkdownノートアプリInkdropで家賃の半分が賄えるようになりました
4月にInkdropの総売上が10万円を超えた報告をしてから、久々の売上報告です。Inkdropはクローズドソースですが、プロジェクトで得た知見は惜しみなくオープンにしていくつもりです。どんどんやり方パクってください。もし質問などあればコメント欄やTwitterにて受け付けます。 TL;DR驚きの解約率の低さ注文の多い少数派を相手にしすぎないブログを始めたら日本のユーザが増えた1000人のユーザが１人を食わせるモデルを確立したいInkdropはMarkdown好きのためのノートアプリ既にInkdropについてご存知の方は読み飛ばして下さい。 Inkdropはマルチプラットフォームで動作するノートアプリです。今のところmacOS、Windows、Ubuntu、iPhone、Androidに対応しています。 日々の作業記録や議事録、コードスニペットからブログの下書きまで、技術的な事柄を構文ハイ
GitHub Flavored Markdown Spec
This formal specification is based on the CommonMark Spec by John MacFarlane and licensed under 1Introduction 1.1What is GitHub Flavored Markdown? GitHub Flavored Markdown, often shortened as GFM, is the dialect of Markdown that is currently supported for user content on GitHub.com and GitHub Enterprise. This formal specification, based on the CommonMark Spec, defines the syntax and semantics of t
Marp - Markdown Presentation Writer
It's a time to migrate into Marp Next! The publication of classic Marp app has ended. Marp desktop app, a simple Markdown presentation writer, already had stopped maintenance since 2017. Today Marp team is focusing into Marp Next project, the brand-new presentation ecosystem for the future. See more details in our blog post. Why? We had kept publishing app for stuck users that are thinking Marp Ne
スライドのプロトタイピングにApp::revealupがべんり - たまめも(tech)
yusukebeさんのApp::revealupというモジュールがあるんですが スライドのプロトタイピングにとってもよかったのでご紹介。 こんなぐあいにmarkdownで書いて、 revealup server -p 5001 --theme night --transition none yapcasia2014.mdこんなぐあいに立ち上げると、 こんなぐあいにプレビューできます。おてがる！ スライドの区切りを気軽に変えられる 一枚のmarkdownを編集するかたちなので中身の移動やコピペがしやすい 全体の流れを確認しやすい すぐにプレビューできる などなどがべんりポイントだとおもいます。 先日のYAPCのスライドはまずApp::revealupをつかってわーっと書き散らかしてからまとめて、keynote上で仕上げる、という過程で作っていました。 LiveReloadなどと組み合わせると
マークダウン記法をマスターするためのサイト・チートシート・ツール。 - あなたのスイッチを押すブログ
「マークダウン記法」というのをご存知でしょうか。 例えばHTMLで文字を強調しようと思うと、文字をstrongで囲うと思います。ですが、いちいちコードを書くのは面倒ですよね。パソコンならスニペットを使えばいいでしょうが、iPhoneなどのモバイル端末では面倒極まりない作業です。 そこで「マークダウン記法」。これは、ある法則に従って記号を使えば、後からHTMLに変換される。文字装飾が行える。そんな簡易文字装飾フォーマットなのです。 ちなみにWikipediaによると… Markdown は、文書を記述するための軽量マークアップ言語のひとつである。「書きやすくて読みやすいプレーンテキストとして記述した文書を、妥当なXHTML（もしくはHTML）文書へと変換できるフォーマット」として、John GruberとAaron Swartzによって考案された。[1] Markdownの記法の多くは、電子
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Markdown を拡張する話
StackEdit – Editor
sakedrink.info