k16shikano

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

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

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

整形

morgyface

<?php
// Sets the default categories
function add_the_categories() {
    $categories = array(
        'Case Study',
        'Blog',
        'Article'
    );
    foreach( $categories as $category ) {
        $exists = term_exists( $category, 'category' );

mecid

import SwiftUI

extension Calendar {
    func generateDates(
        inside interval: DateInterval,
        matching components: DateComponents
    ) -> [Date] {
        var dates: [Date] = []
        dates.append(interval.start)

rizumita

import Foundation
import Combine

public func async<T>(_ body: @escaping (Yield<T>) throws -> ()) -> Async<T> {
    Async(body: body)
}

public func await<P>(_ publisher: P) throws -> P.Output where P: Publisher {
    try publisher.await()
}

T1T4N

protocol CaseEquatable {
    associatedtype Case: Equatable
    var `case`: Case { get }

    static func ~=(lhs: Self, rhs: Self) -> Bool
}

extension CaseEquatable {
    static func ~=(lhs: Self, rhs: Self) -> Bool {
        return lhs.case == rhs.case

the-yuyut

Resource:

Creating a custom Combine Publisher to extend UIKit: https://www.avanderlee.com/swift/custom-combine-publisher/

Usage

let button = UIButton()
button
.publisher(for: .touchUpInside)
.sink{ control in print("touch up inside")}

lisawolderiksen

Using Git Commit Message Templates to Write Better Commit Messages

The always enthusiastic and knowledgeable mr. @jasaltvik shared with our team an article on writing (good) Git commit messages: How to Write a Git Commit Message. This excellent article explains why good Git commit messages are important, and explains what constitutes a good commit message. I wholeheartedly agree with what @cbeams writes in his article. (Have you read it yet? If not, go read it now. I'll wait.) It's sensible stuff. So I decided to start following the

darrarski

import Quick
import Nimble

class CodableDecimalSpec: QuickSpec {
    override func spec() {
        context("encode Model to JSON") {
            var model: Model!
            var json: [String: String]?

            beforeEach {

calosth

import UIKit

// Conform the `Polygon` protocol to specify the vertices of the polygon.
protocol Polygon {
    var vertices: [CGPoint] { get }
}

// UIView conforms the protocol `Polygon` to specified the vertices of the rectangle.
extension UIView: Polygon {

onevcat

import UIKit
import WebKit

// Disableing `WKWebView` user zooming by returning `nil` in `UIScrollViewDelegate`'s
// `viewForZooming` delegate method.
// On iOS 12, the delegate method only called when set the web view itself as the
// scroll view delegate.

class WebView: WKWebView {}