ymmt2005

技術文書の書き方

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

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

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

kb10uy

;; -*- fundamental -*- ; coding: utf-8 -*-
;; okuri-ari entries.
いr /挿入/
かk /顔射/自慰/
きm /理性崩壊/
こk /自慰/
じこr /避妊失敗/
じこt /避妊失敗/
だs /射精/排卵/
でc /射精/排卵/

cormojs

/// オリジナルの文 https://en.wikipedia.org/wiki/Language_interpretation
// Interpreting is a translational activity in which one produces a first and final translation on the basis of a one-time exposure to an expression in a source language.

/// 目標とすべき理想的解答
// 通訳これハかれガ或る原本言語ノなかデ或る表現エ向かう或る一時的ナ露出ノ其の基本ノ上えデ或る最初的ナ且つ最終的ナ翻訳ヲ産むところノ或る翻訳的ナ活動ダ。

//// ---- これ以降は一番下のブロックから順番に読んでね！

/// 一般的でない送り仮名の物を平仮名に開く。これで理想的解答と一致した。
// 通訳これハかれガ或る原本言語ノなかデ或る表現エ向かう或る一時的ナ露出ノ其の基本ノうえデ或る最初的ナ且つ最終的ナ翻訳ヲ産むところノ或る翻訳的ナ活動ダ。

orange-in-space

using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Runtime.InteropServices;
using System.Text;

namespace Orange.SpotifyTools
{

okapies

Mastodon が他のインスタンスと情報交換をする OStatus API の使い方。使ってるだけのユーザは知る必要がない裏側の話。

host-meta

Mastodon インスタンスに対して、RFC6415 が規定する /.well-known/host-meta というパスを要求すると以下の XML が返ってくる.

<?xml version="1.0"?>
<XRD xmlns="http://docs.oasis-open.org/ns/xri/xrd-1.0">
  <Link rel="lrdd" type="application/xrd+xml" template="https://[MASTODON_HOST]/.well-known/webfinger?resource={uri}"/>
</XRD>