Skip to content

Instantly share code, notes, and snippets.

View niku's full-sized avatar
💭
🍖

KITAMURA Daisuke niku

💭
🍖
View GitHub Profile
@k16shikano
k16shikano / SKILL.md
Last active July 6, 2026 05:37
japanese-tech-writing/SKILL
name japanese-tech-writing
description 日本語の技術文書・書籍原稿の文章規範。整形(一文一行、引用ブロック、脚注、コラム記法)、段落と論証の構成(パラグラフライティング)、論証の厳密さ(ツッコミどころの除去)、読み手の負荷の管理、視点と語り、演出の抑制、LLM っぽい空句の禁止、冗長の排除を定める。日本語で技術書の章、草稿、記事、解説文を書くとき、または推敲・リライトするときに使用する。

日本語技術文書の文章規範

日本語で技術的な原稿(書籍の章、記事、解説文)を書く・推敲するときは、以下の規範に従う。

整形

@voluntas
voluntas / shiguredo_model.rst
Last active September 12, 2025 00:11
時雨堂を支えるビジネスモデル

時雨堂を支えるビジネスモデル

更新:2023-12-08
作者:@voluntas
バージョン:2023.2
URL:https://voluntas.github.io/

タイポなどは Twitter の @voluntas までお願いします。

@voluntas
voluntas / shiguredo_azuki.rst
Last active January 10, 2022 06:51
WebRTC P2P+MCU Azuki (仮)

WebRTC P2P+MCU Azuki (仮)

日時:2020-05-06
作:時雨堂
バージョン:2020.5

このプロダクトに興味がある人はこの資料に Star をつけてもらえると嬉しいです。

@voluntas
voluntas / hireling_erlang_vm_contributor.rst
Last active December 13, 2023 02:48
Erlang VM に貢献したい人を探しています

Erlang VM に貢献したい人を探しています

更新:2023-12-14
バージョン:2023.1
作者:@voluntas
URL:http://voluntas.github.io/

概要

アーキテクチャ設計のドキュメンテーション

コンテキスト

アジャイルプロジェクトのアーキテクチャは、別々に記述され定義されなければなりません。すべての意思決定が一度にされるわけでもなく、プロジェクト開始時にすべての意思決定がされてるわけでもありません。

アジャイル手法では、ドキュメンテーションに反対はしませんが、価値のないドキュメンテーションはいけません。チーム自身の助けになるようなドキュメントは価値がありますが、ちゃんと最新化し続けなければなりません。膨大なドキュメントでは、最新化されなくなることでしょう。小さくまとまりのあるドキュメントは少なくとも更新される可能性はありますよね。

また膨大なドキュメントはだれも読みません。たいていの開発者はソースコードサイズの合計よりも(byte的な意味で)大きな仕様書が書かれたプロジェクトを少なくとも1回は経験したことがあるでしょう。開くのにも、読むのにも、更新するのにも、そんなドキュメントは大きすぎます。一口大のピースに分解すれば、すべての関係者にとって消化するのは簡単になりますよね。

プロジェクトが動いている間、追跡するのが難しいことの1つに、ある意思決定の裏に隠された「思い」があります。プロジェクトに新しく参画した人は、それまでに決定されたことに困惑したり、戸惑ったり、喜んだり、怒ったりすることでしょう。理念や因果関係を理解しておかないと、その人は次の2つの選択をすることになります。

@voluntas
voluntas / sora_labo.md
Last active March 28, 2026 01:17
時雨堂 Sora Labo 開発ログ
@voluntas
voluntas / webrtc.rst
Last active June 8, 2026 06:11
WebRTC コトハジメ
@PurpleBooth
PurpleBooth / README-Template.md
Last active July 4, 2026 06:59
A template to make good README.md

Project Title

One Paragraph of project description goes here

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

Erlang で、relx と sync を使ったお手軽自動リロード開発環境コトハジメ

relx コトハジメ の内容を把握している読者を想定しています。

Dockerイメージなどを開発環境にしていると、なるべく実際に動く環境に近いような動作環境でテストしたくなります。

一方で、開発環境というのはなるべく手間なく勝手にコンパイルやテストが走ったり、変更点を勝手にリロードしてほしいものです。

relx を使ってリリースイメージに近いような環境でソフトウェアを起動しつつ、 sync を使って自動コンパイル&リロードする環境を作ろうというのがこの記事の趣旨です。

@voluntas
voluntas / relx.rst
Last active June 10, 2016 13:03
relx コトハジメ