37
26

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 1 year has passed since last update.

記事やソースコードを公開するときに気をつけていること - テックブログガイドライン

Last updated at Posted at 2021-10-06

記事を書いてみよう!という人に、楽しく書くために!
こういうことに気をつけようを説明するために書いたもの。

1. 規約、ガイドライン

Qiita - コミュニティガイドライン - Qiita:Support
Zenn - Modern Knowledge Base for Developers
note ご利用規約

記事をどこに書くべきか、何を書くべきか、どう書くべきか、の問題
引用:ブログに書くか、Qiitaに書くか(技術系のネタを)

上の観点で一番重要なのは「自分の庭」vs「みんなの公園」という考え方かもしれません。
Qiitaは「みんなの公園」なので、ルールやマナーに従ってみんなが気持ちよく使えるようにしなければなりません。Qiitaのルールやマナーについては以下のページに詳しく書いてあります。最低限、ここに書いてあるガイドラインは守るべきです。

  • Qiitaは技術が主語の技術記事
  • Zennは「人が主語の技術記事とアイディアノート」も許容する場合もある
  • noteは「クリエイター」の発表の場

Qiitaがふさわしい

  • つまり、いわゆるテクニカルライティング的文章

Qiitaコミュニティガイドライン詳細

  • プログラミングに関する再利用性・汎用性の高い情報が集まる場をつくろう
  • 「プログラマーが興味を持つものではなく、プログラミングに関する記事を投稿しましょう。」、この表現は結構難しい。

ソースコードの割合が多ければわかりやすいが以下例はどうか

  • ソースコードの読み方
  • レビューの仕方
  • チームビルディング
  • 読書記録
  • 動画の視聴記録
  • イベントの開催報告

よりどころとすべきは、どこまで自分がこのガイドラインを「誠実」に考えて記事を書いたか、説明できるかになってくる。

コミュニティガイドライン

エンジニアにとって再利用性・汎用性の高い情報が集まる場をつくろう
「あなた」と「誰か」がつながる場としていこう
エンジニアとしてのアイデンティティを確立し、表現していこう
Qiitaでの「エンジニア」の定義
Qiitaを利用するにあたってのマナー

Qiitaを利用する際には「HRT」を大切にしよう
☝ エンジニアにとって再利用性・汎用性の高い記事を書こう
☝ 読み手にとって適切な表現を心がけよう
☝みんなが読んでも理解できる記事を書こう
☝ 参考にした記事は参考文献として記載しよう
☝ 記事の価値はみんなで高めよう

Qiitaで記事を公開するときに気を付けるべきマナーについて 〜無断でネットや書籍の内容を丸写しするのはやめよう〜 も一読。

個人ブログがふさわしい

  • まったく技術系でない話(子育ての話とか音楽の話とか)
  • 技術系だけどコードの割合が少ない話
  • ブログは「自分の庭」なので、主役は自分自身
  • PV(閲覧数)の面では若干不利(めちゃくちゃ有名なブロガーでない限り)
    - (引用:ブログに書くか、Qiitaに書くか(技術系のネタを))
  • つまり、いわゆるクリエイティブライティング的文章

まよったら

2. GitHub規約、注意点

https://docs.github.com/ja/github
https://www.csaj.jp/documents/NEWS/pr/210202_Github.pdf

Fork

fork する意味

貢献を意図していないにもかかわらず、オリジナル・リポジトリを fork した場合、オリジナルの開発者に貢献の意思があると誤解されることがある。注意が必要だ。

リポジトリが削除されたり可視性が変更されたりするとフォークはどうなりますか?

パブリックリポジトリをプライベートリポジトリに変更する
パブリックリポジトリを非公開にすると、そのパブリックフォークは新しいネットワークに分割されます。 パブリックリポジトリの削除と同様に、既存のパブリックフォークの 1 つが新しい親リポジトリとして選択され、他のすべてのリポジトリはこの新しい親から分岐されます。 後続のプルリクエストは、この新しい親に行きます。

言い換えれば、パブリックリポジトリのフォークは、親リポジトリが非公開にされた後も、独自の別のリポジトリネットワークで公開されたままになります。 これにより、フォークオーナーは作業を中断せずに作業を継続できます。 このようにパブリックフォークが別のネットワークに移動されなかった場合、それらのフォークのオーナーは適切なアクセス許可を取得してプルする必要があります。 以前はこれらのアクセス権が必要ではなかったとしても、(現在はプライベートになっている) 親リポジトリからの変更を取得して送信します。

3. 法務知識 - ライセンス・著作権

著作権に気をつける
著書や人のブログにまつわる記事を書くと著作権違反になる?
ライセンスをつけないとどうなるの? (Github)
「Log4j」の脆弱性を突く攻撃手段の情報共有は違法? 日本ハッカー協会に聞いた - ITmedia NEWS

翻訳

記事作成に翻訳ツールを利用する際の注意
海外サイトの無断翻訳時に想定されるトラブル
https://www.joho-translation.com/topic_englishtranslation_162.html
を考えたときに、ご本人の許可を尋ねるならこのような感じ。

Hello!
I find your article very interesting.
Could I translate it into Japanese and post it on Qiita (https://qiita.com/(My ID or someURL))?
It is one of the most popular platform for Japanese developers (over 7 million users per month).
I will link to your article/profile page too.

本の要約

本の要約

ソースコード

「よいサンプルコード」ってどんなサンプルコード? 〜Qiitaや技術ブログを書くときに気を付けること〜 - Qiita

素材

【2020年版】パブリックドメインで無料!世界の名画550万枚をダウンロードできる美術館サイト19個まとめ - PhotoshopVIP
これが無料?優秀なフリーイラスト素材サイト30(商用利用可)
2.400万点以上の高品質なフリー画像素材 - Pixabay
Beautiful Free Images & Pictures | Unsplash
Artvee
商用可・フリーイラスト素材|ソコスト

その他 スライドに使用可能な素材等と同様
Wikipediaの画像を二次使用&引用する方法 → ものにより気をつけること
ジブリのフリー素材、商用利用は? | これって違法?〜ブログ・SNS著作権解説〜 → 商用はよろしくなさそう

テストデータ

人物画像
思わぬ事故防止!開発時やテスト時に使用するメアドのドメインは example.com に統一しよう - Qiita

4. 広報知識 - 宣伝行為

宣伝行為、記事の線引きなど、コミュニティガイドラインについての補足説明
最近は以下も歓迎してくださっている

対策

広報が知っておきたい、企業の炎上対策・炎上時の対応方法について徹底解説【危機管理広報】 | PR TIMES MAGAZINE
NHK放送ガイドライン(インターネットガイドライン統合版)|経営に関する情報|NHKについて

5. その他話題の、開発が知っておくと良い知識

スクレイピング

Webスクレイピングの注意事項一覧

公開APIの規約例

公開APIの規約
https://cl.asahi.com/api_data/term_api.html

長文要約生成APIを利用する前に気をつけたいこと

その他テキストコピペ系Webサービス

DeepL翻訳をはじめとしたテキストコピペ系Webサービスは機密情報の扱いに注意しよう

6. 話題の選び方

君たちに問う!君たちはプログラマか!!
ここ2ヶ月の「Qiita」と「アウトプット」についての議論まとめ

でも書くとよい理由

拝啓 本当は Qiita を書きたいのに、まだ迷っているあなたへ。
Qiitaの記事には絶対コメントを書いてはいけない (わけがない)
技術記事の3類型: 初心者による技術記事執筆のすすめ
技術記事を書く人を大事にしよう
「SNS疲れ」と「発信」、「アウトプット」の線引き

随時追記 楽しく書くために。
以上、参考になればさいわいです。

37
26
2

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
37
26

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?