Activity for Jason Fox
Type | On... | Excerpt | Status | Date |
---|---|---|---|---|
Edit | Post #26402 | Initial revision | — | about 5 years ago |
Edit | Post #26321 | Initial revision | — | about 5 years ago |
Edit | Post #26091 | Initial revision | — | about 5 years ago |
Edit | Post #26083 | Initial revision | — | about 5 years ago |
Question | — |
Should the documentation of a known issue change dependent on the stability of a product release? I am writing the release documentation for a software product and a design flaw has been discovered after the code has been frozen. Does the documentation describing this issue change if the product is a beta release to selected customers only? What if the product is a 1.0 to be exposed to a public a... (more) |
— | almost 7 years ago |
Question | — |
How should I document a product release with an inherently flawed design? The deadline is looming and someone realizes the product can't be shipped without documentation. Once the product leaves the remit of the software engineers (who obviously only ever write wonderful code) and is passed on to a more objective audience an obvious design flaw is discovered. May be the pa... (more) |
— | almost 7 years ago |
Question | — |
How to effectively document a product composed of complex microservices? I have a highly flexible software product consisting of a series of loosely coupled microservices. Each component is effective at a single job, but may be dependent on inputs from other services. It is expected that additional services will be added later. The overall product could be considered to ... (more) |
— | almost 7 years ago |
Answer | — |
A: What are the benefits of including complete working code samples in documentation I can understand the reasoning from both sides. A complete quick start is essential to ensure that the reader has sufficient information to see the product running correctly, and is able to demonstrate and present a sample default use case to the user, without these the casual reader will not know wh... (more) |
— | almost 7 years ago |