Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

「東京都オープン・ソース・ソフトウェア公開ガイドライン.md」の書き換え #5

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

nard-tech
Copy link

行政文書としてはよくても,Markdown で記述し GitHub 上で公開する技術文書としては相応しくない点が多々見受けられたので書き換えた.

@@ -1,341 +1,412 @@
# **東京都オープン・ソース・ソフトウェア公開ガイドライン(β版(0.1.0版))**
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

「オープン・ソース」は「オープンソース」に統一した.
また,意味のない太字の設定は削除した.

@@ -1,341 +1,412 @@
# **東京都オープン・ソース・ソフトウェア公開ガイドライン(β版(0.1.0版))**

## 第1 オープンソース・ソフトウェア公開ガイドライン策定の背景と目的
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

「第1」のような付番をすると,新しい項目を追加した際に番号を振り直す必要が生じてしまい,修正コストが大きくなる.

また,全角英数字は技術文書では避けられる傾向にある.

## 第1 オープンソース・ソフトウェア公開ガイドライン策定の背景と目的

### 1 新型コロナウイルス感染症対策サイト構築から見えてきた世界
<span> </span>新型コロナウイルス感染症が拡大の傾向を見せるなか、都では、今までに経験したことのない状況下で、正確な情報を都民に迅速に届けるため、「東京都新型コロナウイルス感染症対策サイト」を開設した。
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

<span> </span> のような字下げは削除した.

また,Markdown で間に空行を入れずに改行すると段落分けが行われず,見にくくなる.(プレビューで誰も確認しなかったのか疑問)

 ※「第3 OSSの管理」内の「コラム:GitHubの仕組み」参照
### 2 都政の構造改革の推進
<span> </span>長期化するコロナ禍で、社会のデジタルシフトが加速している。こうした、社会の大きな変化、変革は、より良い社会を実現する好機ととらえることもできる。
 このため、都は、DX(デジタル・トランスフォーメーション)の推進を梃子として、都政のQOSを向上させることで、都民のQOL(クオリティ・オブ・ライフ)を高め、誰もが安全・安心で幸せを享受できる社会の実現を目指していくこととしている。
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

「デジタル・トランスフォーメーション」のようなカタカナ表記の用語に対する括弧は全角とする.


## 第2 OSSの定義
<span> </span>都は前述したOSS化がもたらす社会的効果を最大限活用していくことを目指し、 都が公開するOSS(以下「“東京都OSS”」という。)が持つべき要素について以下のとおり定義する。
### 1 OSSに求められる要素※
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

「※」のような記号は機械判読性が悪いので極力避けるべきである.

@nard-tech nard-tech force-pushed the feature/rewrite-document branch 2 times, most recently from 122c341 to 649675d Compare October 27, 2021 19:16

#### 派生ソフトウェアの配布が可能

ソフトウェアの変更と派生ソフトウェアの作成を可能とする。ただし、ライセンスの適用については、「[公開時のライセンス](#公開時のライセンス)」を参照するものとする。
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

各見出しへジャンプできるようにリンク機能を用いた.
また,原則として半角英数字のみの用語_数値の前後には半角スペースを入れるようにした.

<span> </span>都は前述したOSS化がもたらす社会的効果を最大限活用していくことを目指し、 都が公開するOSS(以下「“東京都OSS”」という。)が持つべき要素について以下のとおり定義する。
### 1 OSSに求められる要素※
”東京都OSS”として公開するものについては、以下の要素を持つものとする。
※OSSに求められる要素の記載内容は、OSI(Open Source Initiative)のオープンソースの定義(The Open Source Definition)に準拠した内容となります。
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

「です」「ます」は「である」に統一した.

”東京都OSS”として公開するものについては、以下の要素を持つものとする。
※OSSに求められる要素の記載内容は、OSI(Open Source Initiative)のオープンソースの定義(The Open Source Definition)に準拠した内容となります。

**(1) 再配布の自由**
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

意味のない太字,全角スペース,手作業による付番をなくした.

| -------- | -------- |
| フォーク | 複製元に、開発や援助の貢献を前提に、都のリモートリポジトリを開発者のリモートリポジトリとして複製すること。 |
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

表組では各セルの文言の前後に一つだけ半角スペースを入れる.


<b>図3 OSS開発から公開までの手順</b>

<div style="text-align: center;">
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

<div style="text-align: center;"> には大した意味はないと思われるので削除した.


<div style="text-align: center;">

![](https://i.imgur.com/pTKTcYF.png)
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

画像には alt 属性のテキストを設定した.

@nard-tech nard-tech force-pushed the feature/rewrite-document branch from 649675d to 2e709d1 Compare October 27, 2021 19:26

本ソフトウェアのご利用にあたっては、今後の東京都の施策に活かしていくため、可能な限り東京都にお知らせください。

#### README ファイルへのその他記載事項
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

見やすさを考慮し,見出しを追加した.

@tmatsuno
Copy link
Member

tmatsuno commented Oct 29, 2021

Pull Requestありがとうございます。
性質の異なる修正が複数混ざっていることから、お手数かとは存じますが、分けていただいたほうがそれぞれの修正適応の実施について検討がしやすく、一部取り込まない決定がされた際はその一部のためにすべてRejectとなると残念ですので、次回以降は適切な単位で分割いただけますと幸いです。

一旦このPRでのご意見は承りました。
確認の上PR内外にかかわらず修正の検討をさせていただきます。

@tmatsuno tmatsuno added complex Things that are complicated or miscellaneous and need to be organized help wanted Extra attention is needed labels Oct 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
complex Things that are complicated or miscellaneous and need to be organized help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants