Edit - Software Engineering Stack Exchange

You are not logged in. Your edit will be placed in a queue until it is peer reviewed.

We welcome edits that make the post easier to understand and more valuable for readers. Because community members review edits, please try to make the post substantially better than how you found it, for example, by fixing grammar or adding additional resources and hyperlinks.

5

Make sure that the "certain documentation" isn't dependent on a particular tool. I've run into a number of projects that used something like SunOS version of Frame to do docs, they checked in all of the ".mif" files, but not the resulting .ps or .pdf files. Now that SunOS and Frame are relegated to the dustbin of history, a lot of design docs only exist as treasured paper copies.

Bruce Ediger
– Bruce Ediger

2011-11-18 16:22:50 +00:00
Commented Nov 18, 2011 at 16:22
2

@BruceEdiger In that case I would personally want both the output and the tool specific information. If the tool disappears, you at least still have a static electronic copy :)

maple_shaft
– maple_shaft ♦

2011-11-18 16:26:11 +00:00
Commented Nov 18, 2011 at 16:26
one of the advantages here of a big process company, the source goes into vcs, the generated stuff has to go into configuration management system, so even if your tool is defunct you still have the results controlled

jk.
– jk.

2011-11-18 21:26:14 +00:00
Commented Nov 18, 2011 at 21:26
How about the specific version of the compiler(s) you're using? Heck, why not the whole OS?

wnoise
– wnoise

2011-11-20 13:24:17 +00:00
Commented Nov 20, 2011 at 13:24

Add a comment |

Correct minor typos or mistakes
Clarify meaning without changing it
Add related resources or links
Always respect the author’s intent
Don’t use edits to reply to the author

create code fences with backticks ` or tildes ~
```
like so
```
add language identifier to highlight code
```python
def function(foo):
print(foo)
```
put returns between paragraphs
for linebreak add 2 spaces at end
_italic_ or **bold**
indent code by 4 spaces
backtick escapes `like _so_`
quote by placing > at start of line
to make links (use https whenever possible)

<https://example.com>

[example](https://example.com)

<a href="https://example.com">example</a>

formatting help »
answering help »