Yoichi Kawasaki yokawasa

技術文書の書き方

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

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

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

Pre-hijacking Attacksについてのメモ書きです。元の論文と記事は次のページを読んでください。

[2205.10174] Pre-hijacked accounts: An Empirical Study of Security Failures in User Account Creation on the Web
New Research Paper: Pre-hijacking Attacks on Web User Accounts – Microsoft Security Response Center

Pre-hijacking Attacks はメールアドレスの確認をしないでアカウントを作れるサービスという前提があります。

アカウント作成からそのまま機能を利用できるようにすることで、利用体験をよくするための施策として、メールアドレスの確認のステップを後回しまたはしないサービスがあります。

Dependabot for Golang based repositories

Minimal YAML configuration for enabling Dependabot within a Golang based repository.

Place dependabot.yaml at .github/dependabot.yaml within your repository and you should be good to go.

Reference

Configuration options for the dependabot.yml file

Golang Cheat Sheet

Golang Cheat Sheet
- Fundarmental
  - Golang Installation
    - Single version
    - Multiple versions
Troubleshoot on golang version upgrade

Kubernetes Tools

Kubernetes Tools
- Links
- kubectx
- stern
- kubefwd
kubespy

VS Code Configurations

VS Code Configurations
- code command
- setting.json
  - editor.formatOnSave
  - editor.renderWhitespace
editor.mouseWheelZoom

Re:VIEWチートシート

いつもいつもいつもRe:VIEWの記法に悩んでぐぐってしまう皆さんへ送るチートシートです。

基本

名称	ルール	概要・備考
段落	1行以上の空行をはさむと別の段落になる	HTMLでいうP
見出し	=ではじまる行	=の個数で、章・節・項・段という感じで増えます。HTMLで言うH1, H2, H3, H4, H5

検討するための情報

Dockerコンテナ上のログを集約する方法

コンテナの内部で集約する
- e.g. fluentd、rsyslog等を各コンテナ内に立てる
- e.g. 単純にファイルに保存する
コンテナの外部で集約する
- e.g. ホスト側にfluentd、rsyslog等を起動して、各コンテナがマウントしたログファイルをtail等で読む

e.g. ホスト側にマウントしてファイルに保存する

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit

	#!/bin/bash

	set -e

	if [ ! -z "$DEBUG" ] ; then
	set -x
	fi

	REGIONS="us-east-2
	us-east-1