ymmt2005

技術文書の書き方

このメモは、私（@ymmt2005）が長年にわたってソフトウェアプロダクト開発に関わってきて 2022年現在こうしたほうが良いと考えているベストプラクティスです。

科学的な分析等に基づくわけではない経験則であるため、今後も随時見直すことがありますし、 ここに書いてあることが常に正しいわけでもあらゆるソフトウェア開発に適するわけでもありません。

しかしながら、実務経験が豊富で、モダンな技術スタックに明るいエンジニアの経験則は一定の 役に立つのではないかと考えて記します。

narutaro

Gistをブログプラットフォームとして使う

いろいろ試した結果、Web上になんか書く時には，とりあえずGistに書いておいて，それをGitHub pagesで束ねるだけでこんな風にそれなりにブログっぽくなっていいんじゃないかと思うにいたったので，そのことについて書こうかと思う．ソースはこちら．

やったこと

GitHub pagesを設定する

GitHub Pagesにコンテンツをホストする方法はいろんなところに書かれているので省略．今回はHTMLにビルドしてからpushするのではなくて，.mdファイルのままpushして，GitHub pagesのJekyllにビルドを任せるやり方．

テーマまわり

1. GitHub pagesのデフォルトテーマの一つをとってきて，ちょっといじる．デフォルトデーマはレスポンシブでiPhoneで見るときもいい感じ．
2. サイトの記事部分は埋め込みGistを使うので，埋め込みGistのCSSをいじって（上書きして）サイトのテーマになじませる
3. テーマはJekyllのお作法に合わせ_layoutにおく

walm

package main

import (
	"fmt"
	"log"
	"strconv"

	"github.com/miekg/dns"
)

mono0926

gitにおけるコミットログ/メッセージ例文集100の転載

例文を組み込んだAlfred Workflowを作りました: Alfred Git Commit Message Example

以下転載:

---

hayajo

package main

import (
	"flag"
	"fmt"
	"io/ioutil"
	"os"
	"text/template"

	"github.com/russross/blackfriday"

deris

vimで使うキーの機能使用頻度と打ちやすさの整理

vimで使うキーの機能使用頻度と打ちやすさを整理してみました。 今回整理したのはnormalモードについてだけです。 機能の使用頻度と打ちやすさは、完全に個人の見解です。 キーボードによっても打ちやすさは変わると思います。

すべてのキーを網羅しているわけではありません。

thinca

" == Naming convention. == {{{1
" Command name
"  - CamelCase
" Global function name
"  - CamelCase
" Local function name
"  - s:split_by_underbar
" Group name for autocmd
"  - split-by-dash
"   In vimrc, start with "vimrc"