Kōhei Yamamoto kymmt90

技術文書の書き方

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

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

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

📝 企業を調べる時のメモ書きです。

Index

前提: 完成していて、比較的支持を集めていて、JavaScriptを中心にした書籍 (DOM APIよりは言語を中心とした内容)

追記: JavaScriptの入門書 #jsprimerを書いている

最初からES2015で学ぶことを前提にした初心者〜中級者向けのJavaScript本がなかったので書いてる。 ES2015でJavaScriptという言語のコア部分は大きく変わったので、それを前提とした内容にする予定。

This list is based on aliases_spec.rb.

	ruby '2.7.1'

	gem 'rails', github: 'rails/rails'
	gem 'tzinfo-data', '>= 1.2016.7' # Don't rely on OSX/Linux timezone data

	# Action Text
	gem 'actiontext', github: 'basecamp/actiontext', ref: 'okra'
	gem 'okra', github: 'basecamp/okra'

	# Drivers

	use std::fmt::*;

	/// A struct that represents a single node in a list
	///
	/// # State
	/// * `element` - The element of type T that is stored in the node
	/// * `next` - An optional value that points to the next element in the list
	#[derive(PartialEq, Debug)]
	pub struct Node<T: Debug> {
	pub element: T,

	;; ref https://github.com/amperser/proselint/issues/37
	;; textlint
	(flycheck-define-checker textlint
	"A linter for prose."
	:command ("textlint" "--format" "unix" "--rule" "no-mix-dearu-desumasu" "--rule" "max-ten" "--rule" "spellcheck-tech-word" source-inplace)
	:error-patterns
	((warning line-start (file-name) ":" line ":" column ": "
	(id (one-or-more (not (any " "))))
	(message (one-or-more not-newline)
	(zero-or-more "\n" (any " ") (one-or-more not-newline)))

	# -- coding: utf-8 --
	require 'mechanize'
	require 'nokogiri'
	require 'kconv'

	module HashInitializable
	def initialize(attributes={})
	attributes.each do \|name,value\|
	send("#{name}=",value)
	end