#softwardocumentation — Public Fediverse posts
Live and recent posts from across the Fediverse tagged #softwardocumentation, aggregated by home.social.
-
Food for thought: When documenting the behavior of a highly customizable and configurable product or feature based on questions from a single customer, a technical writer should always consider the scope of the final documentation artifact. This requires making a clear distinction between what is specific to that customer and what is generalizable and easily reproducible by all.
If we don't enforce that strict separation, we run the risk of transforming the artifact into a laundry list of uncontextualized items that are mostly unintelligible for the other customers. In those cases involving very specific scenarios, sometimes what the customer really needs is not necessarily more documentation but rather a detailed technical conversation from our engineering team with their developers explaining how they can by themselves find answers for those questions whenever they need them :)
-
Food for thought: When documenting the behavior of a highly customizable and configurable product or feature based on questions from a single customer, a technical writer should always consider the scope of the final documentation artifact. This requires making a clear distinction between what is specific to that customer and what is generalizable and easily reproducible by all.
If we don't enforce that strict separation, we run the risk of transforming the artifact into a laundry list of uncontextualized items that are mostly unintelligible for the other customers. In those cases involving very specific scenarios, sometimes what the customer really needs is not necessarily more documentation but rather a detailed technical conversation from our engineering team with their developers explaining how they can by themselves find answers for those questions whenever they need them :)
-
Food for thought: When documenting the behavior of a highly customizable and configurable product or feature based on questions from a single customer, a technical writer should always consider the scope of the final documentation artifact. This requires making a clear distinction between what is specific to that customer and what is generalizable and easily reproducible by all.
If we don't enforce that strict separation, we run the risk of transforming the artifact into a laundry list of uncontextualized items that are mostly unintelligible for the other customers. In those cases involving very specific scenarios, sometimes what the customer really needs is not necessarily more documentation but rather a detailed technical conversation from our engineering team with their developers explaining how they can by themselves find answers for those questions whenever they need them :)
-
Food for thought: When documenting the behavior of a highly customizable and configurable product or feature based on questions from a single customer, a technical writer should always consider the scope of the final documentation artifact. This requires making a clear distinction between what is specific to that customer and what is generalizable and easily reproducible by all.
If we don't enforce that strict separation, we run the risk of transforming the artifact into a laundry list of uncontextualized items that are mostly unintelligible for the other customers. In those cases involving very specific scenarios, sometimes what the customer really needs is not necessarily more documentation but rather a detailed technical conversation from our engineering team with their developers explaining how they can by themselves find answers for those questions whenever they need them :)
-
Food for thought: When documenting the behavior of a highly customizable and configurable product or feature based on questions from a single customer, a technical writer should always consider the scope of the final documentation artifact. This requires making a clear distinction between what is specific to that customer and what is generalizable and easily reproducible by all.
If we don't enforce that strict separation, we run the risk of transforming the artifact into a laundry list of uncontextualized items that are mostly unintelligible for the other customers. In those cases involving very specific scenarios, sometimes what the customer really needs is not necessarily more documentation but rather a detailed technical conversation from our engineering team with their developers explaining how they can by themselves find answers for those questions whenever they need them :)