Communities

Writing
Writing
Codidact Meta
Codidact Meta
The Great Outdoors
The Great Outdoors
Photography & Video
Photography & Video
Scientific Speculation
Scientific Speculation
Cooking
Cooking
Electrical Engineering
Electrical Engineering
Judaism
Judaism
Languages & Linguistics
Languages & Linguistics
Software Development
Software Development
Mathematics
Mathematics
Christianity
Christianity
Code Golf
Code Golf
Music
Music
Physics
Physics
Linux Systems
Linux Systems
Power Users
Power Users
Tabletop RPGs
Tabletop RPGs
Community Proposals
Community Proposals
tag:snake search within a tag
answers:0 unanswered questions
user:xxxx search by author id
score:0.5 posts with 0.5+ score
"snake oil" exact phrase
votes:4 posts with 4+ votes
created:<1w created < 1 week ago
post_type:xxxx type of post
Search help
Notifications
Mark all as read See all your notifications »

Posts by Jason Fox‭

4 posts
66%
+2 −0
Q&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 demonst...

posted 7y ago by Jason Fox‭  ·  last activity 5y ago by System‭

Answer
60%
+1 −0
Q&A 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 produc...

1 answer  ·  posted 7y ago by Jason Fox‭  ·  last activity 5y ago by System‭

60%
+1 −0
Q&A 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. I...

1 answer  ·  posted 7y ago by Jason Fox‭  ·  last activity 5y ago by System‭

50%
+0 −0
Q&A 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...

2 answers  ·  posted 7y ago by Jason Fox‭  ·  last activity 5y ago by System‭