ymmt2005

技術文書の書き方

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

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

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

greymd

　オレは高校生シェル芸人 sudo 新一。幼馴染で同級生の more 利蘭と遊園地に遊びに行って、黒ずくめの男の怪しげな rm -rf / 現場を目撃した。端末をみるのに夢中になっていた俺は、背後から近づいてきたもう１人の --no-preserve-root オプションに気づかなかった。 俺はその男に毒薬を飲まされ、目が覚めたら・・・ OS のプリインストールから除かれてしまっていた！

『 sudo がまだ $PATH に残っていると奴らにバレたら、また命を狙われ、他のコマンドにも危害が及ぶ』

　上田博士の助言で正体を隠すことにした俺は、 which に名前を聞かれて、とっさに『gnuplot』と名乗り、奴らの情報をつかむために、父親がシェル芸人をやっている蘭の $HOME に転がり込んだ。ところが、このおっちゃん・・・とんだヘボシェル芸人で、見かねた俺はおっちゃんになりかわり、持ち前の権限昇格能力で、次々と難タスクを解決してきた。おかげで、おっちゃんは今や世間に名を知られた名エンジニア、俺はといえばシェル芸 bot のおもちゃに逆戻り。クラスメートの convert や ojichatや textimg にお絵かきコマンドと誤解され少年ワンライナーお絵かき団を結成させられる始末。

　ではここで、博士が作ってくれたメカを紹介しよう。最初は時計型麻酔 kill 。ふたについた照準器にあわせてエンターを押せば、麻酔シグナルが飛び出し、プロセスを瞬時に sleep させることができる。 次に、蝶ネクタイ型 banner 。裏についているダイヤルを調整すれば、ありとあらゆる大きさのメッセージを標準出力できる。必殺のアイテムなら fork 力増強シューズ。電気と磁力で足を刺激し、 :(){ :|:& };: でプロセステーブ

su-kun1899

はじめに

• "監視とは、あるシステムやそのシステムのコンポーネントの振る舞いや出力を観察しチェックし続ける行為である"
• 基本原則は時代を超えるもの

１章 監視のアンチパターン

• 慣習を見直す
  • 「いつもやってることだから」で済まさない
• ツール依存

higeknuckle

[プロジェクトのタイトル。例：作成するライブラリの名前は？]

プロジェクトの目的

[何を実現するの？]

プロジェクトの背景

[どんな背景があるから実現するの？]

ハイレベルアーキテクチャ

[コードだけでは分からない作成物のアーキテクチャを画像などで]

catatsuy

ISUCONのベンチマーカーとGo

catatsuy メルカリSRE

mercari.go #11 - connpass https://mercari.connpass.com/event/148913/

ISUCONとは

http://isucon.net

catatsuy

GoでISUCONを戦う話

mercari.go #4 https://mercari.connpass.com/event/105640/

自己紹介

• catatsuyというIDで各種SNS活動しています
  • かたついって呼ばれています
• メルカリのSREチームで主にGoを書いています
• 前職はピクシブでpixivのHTTPS化・PHP7.1化・HTTP/2化や、広告サーバーの新機能追加など色々やっていました

pasora

#!/bin/bash

for f in $(git status | gawk 'BEGIN{staged=0}{if(staged){if(/modified:/){print gensub(/.*modified:[ \\t]*(.*)/,"\\1","g",$0)}}if(/^Changes not staged for commit:$/){staged=1}}')
do
  clear
  git status

  echo "Target file: ${f}"

  # git diff

alexedwards

package main

import (
	"database/sql"
	"testing"
	"time"

	_ "github.com/lib/pq"
)

enricofoltran

package main

import (
	"context"
	"flag"
	"fmt"
	"log"
	"net/http"
	"os"
	"os/signal"

south37

集合

9:00にオフィス(Sticky Fingers)

食料品は事前に用意しておく。食べ過ぎない。胃に負担をかけないようにする。

運営の櫛井さんからのメールに従って、サポートチャットと予選ポータルサイトにログインする。

• ISUCON6 予選レギュレーション
• メール: ISUCON6 オンライン予選 当日の流れについて