質問編集履歴

4

誤字の修正

2021/01/19 04:52

投稿

odds0128
odds0128

スコア31

test CHANGED
File without changes
test CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
 
6
6
 
7
- - ソフトウェア要仕様書
7
+ - SRS(ソフトウェア要仕様書)
8
8
 
9
9
  - 非機能要件定義書
10
10
 
@@ -16,7 +16,7 @@
16
16
 
17
17
  私は正直なところ,そんなものはないと思っています.
18
18
 
19
- 理由は,生成したいものは上流工程の物である一方で,ソースコードは最終成果物で最下流のものであるため,遡るには遠すぎると思うからです.
19
+ 理由は,生成したいものは比較的上流の物である一方で,ソースコードは最終成果物で最下流のものであるため,遡るには遠すぎると思うからです.
20
20
 
21
21
  この点に関して何かご意見ございましたら是非伺いたく存じます.
22
22
 

3

表現が正確になるように修正

2021/01/19 04:52

投稿

odds0128
odds0128

スコア31

test CHANGED
@@ -1 +1 @@
1
- ソースコードから上流工程のドキュメントを自動生成したい
1
+ ソースコードから運用必要なドキュメントを自動生成・更新したい
test CHANGED
@@ -1,8 +1,8 @@
1
- Javaのソースコードから上流工程のドキュメントを自動生成するようなツールやコマンド・やり方など何かないでしょうか?
1
+ Javaのソースコードから以下のドキュメントを自動生成するようなツールやコマンド・やり方など何かないでしょうか?
2
2
 
3
3
  あるいはGitの変更履歴などからドキュメントを自動更新するような物でも構いません.
4
4
 
5
- 「上流工程のドキュメント」とは,例えば以下のようなものを指しています.
5
+
6
6
 
7
7
  - ソフトウェア要件仕様書
8
8
 

2

文法の修正

2021/01/18 08:55

投稿

odds0128
odds0128

スコア31

test CHANGED
File without changes
test CHANGED
@@ -28,9 +28,7 @@
28
28
 
29
29
  私が対象としているプロジェクトでは、変更があってもドキュメントの更新をせず、直接ソースコードを書き換えているような状況です。
30
30
 
31
- 逆に言えばソースコードは最新であることが保証されているため
31
+ 逆に言えばソースコードは最新であることが保証されているため上記のようなものを探しておりました。
32
-
33
- 上記のようなものを探しておりました。
34
32
 
35
33
 
36
34
 
@@ -40,6 +38,6 @@
40
38
 
41
39
 
42
40
 
43
- 漠然とした質問ですし、そもそもTeratailにそぐわないものであることは百も承知ですが、
41
+ 漠然とした質問ですし、そもそもteratailにそぐわないものであることは百も承知ですが、
44
42
 
45
43
  お力添えいただければ幸いです。

1

質問の背景の説明を追記

2021/01/18 03:25

投稿

odds0128
odds0128

スコア31

test CHANGED
File without changes
test CHANGED
@@ -19,3 +19,27 @@
19
19
  理由は,生成したいものは上流工程の物である一方で,ソースコードは最終成果物で最下流のものであるため,遡るには遠すぎると思うからです.
20
20
 
21
21
  この点に関して何かご意見ございましたら是非伺いたく存じます.
22
+
23
+
24
+
25
+ 【2021/01/18 追記】
26
+
27
+ 対象となるのは新規ではなく既存のプロジェクトです。
28
+
29
+ 私が対象としているプロジェクトでは、変更があってもドキュメントの更新をせず、直接ソースコードを書き換えているような状況です。
30
+
31
+ 逆に言えばソースコードは最新であることが保証されているため、
32
+
33
+ 上記のようなものを探しておりました。
34
+
35
+
36
+
37
+ 私自身そのような都合の良いものはないと考えていますが、
38
+
39
+ どうしても「そうだとして、なぜできないのか?」を知りたいのです。
40
+
41
+
42
+
43
+ 漠然とした質問ですし、そもそもTeratailにそぐわないものであることは百も承知ですが、
44
+
45
+ お力添えいただければ幸いです。