tetsuya infra tetsuyainfra

技術文書の書き方

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

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

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

WebRTC スタックについて

foo_idのpresenceでは、存在しないIDでも保存できてしまう
- fooを参照した際はnilが返る
fooのpresenceを指定すると、foo_idへの代入ではバリデーションを通らなくなる
- fooに未保存のオブジェクトを代入してsave!するとPG::NotNullViolationが発生する
  - PG::NotNullViolation: ERROR: null value in column "character_id" violates not-null constraint
Polymorphic association
- validates :foo_type, presence: trueは不要
クラスが存在しない場合はsave!時にNameError: uninitialized constant XXXが発生する

lxc
- LXC - Wikipedia
- OSレベル の仮想化ソフトウェア
  - 完全仮想化（ハードウェアをエミュレート、オーバーヘッド大） - KVM etc
  - 準仮想化（ゲストOSがホストOSのAPIを使用、オーバーヘッド中） - Xen, Hyper-V etc。Virtualboxもこちらか
仮想機械ではなく、個別のプロセスとネットワークスペースを作り出す仮想環境

	#!/bin/bash
	# Copyright (c) 2010-2013 Luis R. Rodriguez <[email protected]>
	#
	# Permission to use, copy, modify, and/or distribute this software for any
	# purpose with or without fee is hereby granted, provided that the above
	# copyright notice and this permission notice appear in all copies.
	#
	# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
	# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
	# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR

	#!/bin/bash

	## Updates to this file are now at https://github.com/giovtorres/kvm-install-vm.
	## This updated version has more options and less hardcoded variables.

	# Take one argument from the commandline: VM name
	if ! [ $# -eq 1 ]; then
	echo "Usage: $0 <node-name>"
	exit 1
	fi

	### No longer needed as of nginx-1.13.6-1.el7_4.ngx.x86_64.rpm from nginx.org
	### it was compiled against OpenSSL 1.0.2 from CentoOS 7.4 so it supports ALPN (HTTP2 works)

	yum -y groupinstall 'Development Tools'
	yum -y install wget openssl-devel libxml2-devel libxslt-devel gd-devel perl-ExtUtils-Embed GeoIP-devel rpmdevtools

	OPENSSL="openssl-1.0.2l"
	NGINX_VERSION="1.13.5-1"
	NJS_VERSION="1.13.5.0.1.13-1"

	# We use Ubuntu 14.04 to build a native gcc for win32 with multilib support
	#
	# Based on:
	# http://sourceforge.net/p/mingw-w64/wiki2/Native%20Win64%20compiler/
	# http://sourceforge.net/p/mingw-w64/code/HEAD/tree/stable/v3.x/mingw-w64-doc/howto-build/mingw-w64-howto-build.txt?format=raw
	#
	# Cross compiling notes:
	# - The minor version of gcc must match that of our cross compiler (4.8 in this case)
	# - Important parameters: http://gcc.gnu.org/onlinedocs/gccint/Configure-Terms.html
	#