技術に関するToot(続き)
Qiita記事やesa.io記事を書く中で「これは半年後などに内容が分からない状況で、どれだけ理解しやすいか?」を自問自答している。
記事を書く時点が「最も」記事を理解している。
その状態でしか分からない記事にすると、半年後に見た時に役に立たない情報になる。
これは記事だけでなくソースコメントやコミットコメントなどでもそうかもしれない。
実際の記事は、上記のように書けてはいないかもしれないが、そういう心がけはしている。
技術に関するToot(続き)
Qiita記事やesa.io記事を書く中で「これは半年後などに内容が分からない状況で、どれだけ理解しやすいか?」を自問自答している。
記事を書く時点が「最も」記事を理解している。
その状態でしか分からない記事にすると、半年後に見た時に役に立たない情報になる。
これは記事だけでなくソースコメントやコミットコメントなどでもそうかもしれない。
実際の記事は、上記のように書けてはいないかもしれないが、そういう心がけはしている。
senooken JP Social is a social network, courtesy of senooken. It runs on GNU social, version 2.0.2-beta0, available under the GNU Affero General Public License.
All senooken JP Social content and data are available under the Creative Commons Attribution 3.0 license.