ymmt2005

技術文書の書き方

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

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

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

airspeedswift

private class MyArrayBuffer<Element>: ManagedBuffer<Int,Element> {
    
    func clone() -> MyArrayBuffer<Element> {
        return self.withUnsafeMutablePointerToElements { elements -> MyArrayBuffer<Element> in
            return MyArrayBuffer<Element>.create(self.allocatedElementCount) { newBuf in
                newBuf.withUnsafeMutablePointerToElements { newElems->Void in
                    newElems.initializeFrom(elements, count: self.value)
                }
                return self.value

nuthatch

- (void)describePreferredFonts
{
    static NSArray *textStyles;
    static dispatch_once_t onceToken;
       dispatch_once(&onceToken, ^{
        textStyles = @[UIFontTextStyleTitle1,   // iOS 9
                       UIFontTextStyleTitle2,   // iOS 9
                       UIFontTextStyleTitle3,   // iOS 9
                       UIFontTextStyleHeadline,
                       UIFontTextStyleSubheadline,

shinyaohira

アプリの状態とマルチタスキング

全体的に簡略化し、必要と思われる部分を抜粋しました。

• Not running

  アプリは起動されていないか、実行されていたけれどもシステムによって終了されています。

• Inactive

piscisaureus

Locate the section for your github remote in the .git/config file. It looks like this:

[remote "origin"]
	fetch = +refs/heads/*:refs/remotes/origin/*
	url = git@github.com:joyent/node.git

Now add the line fetch = +refs/pull/*/head:refs/remotes/origin/pr/* to this section. Obviously, change the github url to match your project's URL. It ends up looking like this: