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 »
Q&A

Posts tagged software-documentation

Subtag of technical-writing

This tag doesn't have any usage information yet.

This tag doesn't have a detailed wiki yet.

57%
+2 −1
Q&A Sphinx: API documentation: How to turn off creating links to Parameter/Argument link creation

For projects with API documentation generated by Sphinx, I've noticed that some project's don't include links to the Parameter/Argument types (str, file-like object, int, etc) and some projects do....

0 answers  ·  posted 3y ago by CodeFarmer‭  ·  last activity 2mo ago by Mithical‭

Question software-documentation
71%
+3 −0
Q&A For HTML documentation sets, are there meaningful guidelines for topic length?

We produce a large HTML documentation set with the conventional two-pane view: expandable table of contents on the left, selected topic on the right. When you select a topic, if it has subtopics --...

2 answers  ·  posted 6y ago by Monica Cellio‭  ·  last activity 12mo ago by Monica Cellio‭

Question technical-writing software-documentation information-architecture
75%
+4 −0
Q&A What are the benefits of including complete working code samples in documentation

When documenting software API so others know how to access the various methods, what data structures are used etc, I like to document each bit in detail and also include, regardless of the coding l...

4 answers  ·  posted 7y ago by Lefty G Balogh‭  ·  last activity 4y ago by Monica Cellio‭

Question software-documentation examples api-documentation
77%
+5 −0
Q&A How should I document a database schema?

I am going to be writing some user-facing documentation for a database that visitors can query. That is, the people writing queries are not the ones who created the database; they can come in, look...

3 answers  ·  posted 11y ago by Monica Cellio‭  ·  edited 4y ago by Monica Cellio‭

Question technical-writing software-documentation user-guides information-architecture
75%
+4 −0
Q&A Good Examples of and Practices in Code Documentation

I noted in this question: What is the best way to learn technical writing? ...that a rated method to learn how to write technical documents is to imbibe good examples. Can you recommend any exam...

1 answer  ·  posted 11y ago by Stefan Piskorski‭  ·  edited 4y ago by Monica Cellio‭

Question technical-writing software-documentation examples api-documentation
50%
+0 −0
Q&A Adding tags to documentation built in Flare?

Our software documentation set (for a SQL analytics database platform) is large, because SQL and databases have many pieces. Often a single statement, function, or feature will be highly related to...

0 answers  ·  posted 6y ago by Monica Cellio‭  ·  edited 4y ago by Monica Cellio‭

Question software tools software-documentation documentation
66%
+2 −0
Q&A How can we format code examples so that they work on a range of devices?

We use Madcap Flare to produce a large documentation set that contains many code examples (primarily SQL, but also C++, Java, and Python) and command-line operations. When the doc set was first pl...

1 answer  ·  posted 5y ago by Monica Cellio‭  ·  last activity 5y ago by manassehkatz‭

Question tools technical-writing formatting software-documentation examples
60%
+1 −0
Q&A Best practices for maintaining documented code examples?

A good SDK (software development kit) includes plenty of well-documented examples. It also includes good tutorials and developer guides, which introduce concepts in logical progressions, typically ...

4 answers  ·  posted 13y ago by Monica Cellio‭  ·  edited 5y ago by Monica Cellio‭

Question technical-writing software-documentation examples
66%
+2 −0
Q&A Documenting framework features and descriptions

We have written a custom software framework and it has grown to the point where we are ready for documentation. This documentation will be used by other developers to share knowledge. I am concerne...

3 answers  ·  posted 5y ago by Grim‭  ·  last activity 5y ago by Monica Cellio‭

Question software technical-writing software-documentation documentation
60%
+1 −0
Q&A Verb tense for technical document titles

I'm writing a technical manual about creating database systems, and wondered what is the best verb tense for title names. My ideas are: Continuous (-ing) form: (e.g. "Creating a Cluster", "Creat...

3 answers  ·  posted 14y ago by Adam Matan‭  ·  last activity 5y ago by System‭

Question software style titles technical-writing software-documentation table-of-contents documentation
60%
+1 −0
Q&A How to include external references when writing internal documentation?

In the IT industry, we often write a lot of technical documentation meant for internal use only. Those documents are often stored in an internal wiki and accessed when the need arises. The conten...

3 answers  ·  posted 6y ago by Liquid‭  ·  last activity 5y ago by System‭

Question software technical-writing citations software-documentation documentation
50%
+0 −0
Q&A What are some standards in naming a software/hardware version?

I am wondering if how we name a version of a spacecraft differs from how we name a version of a software. For software, I usually see things like "2.0.32.32" or something like that and sometimes th...

1 answer  ·  posted 6y ago by blackbird‭  ·  last activity 5y ago by System‭

Question software naming technical-writing software-documentation conventions documentation
50%
+0 −0
Q&A Should software product release notes be in marketing voice or technical voice? (software documentation)

Typically, the voice of marketing content doesn't match the voice of technical content -- marketing is trying to persuade you that you need something; technical writing is generally instructing you...

3 answers  ·  posted 7y ago by Sharon M‭  ·  last activity 5y ago by System‭

Question software style technical-writing notes software-documentation release-notes documentation
60%
+1 −0
Q&A How to eliminate standoff between "Lengthy" vs "Concision"?

Often while writing a software requirement/change-request documentation, I need to include the quoted requirements descriptively, the impacted modules, the changes provided both in UI and in logic....

3 answers  ·  posted 5y ago by Karan Desai‭  ·  last activity 5y ago by System‭

Question software description script technical-writing software-documentation documentation
60%
+1 −0
Q&A Methods for writing a code review

I currently spend a good deal of time over at Code Review and I would love to improve the quality of the reviews I write. Can you give me any insight into the structure or approach you use when wri...

2 answers  ·  posted 6y ago by AGirlHasNoName‭  ·  last activity 5y ago by System‭

Question software criticism technical-writing software-documentation feedback documentation
50%
+0 −0
Q&A Strategies for writing software design documents

I'm a self-taught programmer which means I started writing software by sitting down at an IDE and hammering out some code. When my decisions ultimately coded me into a corner I would refactor and r...

2 answers  ·  posted 6y ago by AGirlHasNoName‭  ·  last activity 5y ago by System‭

Question software technical-writing software-documentation documentation
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‭

Question software organization technical-writing software-documentation information-architecture documentation format
60%
+1 −0
Q&A How can I get a technical writing job for software apps without a degree? [closed]

I have no degree and I cannot afford to have one, however, I would really love to get into technical writing because I love writing and I am interested in web and software development. Right now, I...

1 answer  ·  posted 6y ago by Camilla S.‭  ·  last activity 5y ago by System‭

Question software technical-writing software-documentation jobs documentation
50%
+0 −0
Q&A Where do I start with C++ documentation?

I am new to programming and am entirely self-taught. I have reached a point in my writing where a solid grasp of documentation standards would be greatly beneficial. My question is not how to add d...

3 answers  ·  posted 7y ago by AGirlHasNoName‭  ·  last activity 5y ago by System‭

Question software technical-writing software-documentation documentation
60%
+1 −0
Q&A Starting a sentence with the name of a program or command-line tool: capitalization?

Say you want to talk about a piece of command-line software, like make or bash or the cp command. These commands are all lower-case, and case-sensitive (i.e. won't work on the computer if you capit...

2 answers  ·  posted 9y ago by interfect‭  ·  last activity 5y ago by System‭

Question software style technical-writing software-documentation documentation
50%
+0 −0
Q&A Format keyboard keys in documents

I'm writing a guide to give step-by-step instructions to complete some tasks on the computer. At some points, I need to indicate pressing keys on the keyboard; how may I format the letter/symbol to...

1 answer  ·  posted 9y ago by Oxwivi‭  ·  last activity 5y ago by System‭

Question software style technical-writing formatting software-documentation user-guides documentation format
60%
+1 −0
Q&A How can I write better code-based reference documentation for programming interfaces?

Programmers can write comments in code that can be automatically turned into API documentation (like Javadoc). All I have to do is add some comments explaining what a class or method does and what...

4 answers  ·  posted 11y ago by Monica Cellio‭  ·  last activity 5y ago by System‭

Question software technical-writing software-documentation api-documentation documentation
60%
+1 −0
Q&A How can I consistently distinguish among tables, fields, and records in a database?

I am describing a database for a scientific publication. The database has many tables, and each table has fields (spreadsheet columns) and records (rows). I spend a lot of time discussing tables a...

1 answer  ·  posted 12y ago by Abe‭  ·  last activity 5y ago by System‭

Question software technical-writing scientific-publishing formatting software-documentation documentation format
60%
+1 −0
Q&A Technical specification for webservice (developers-oriented) - examples, methods & instruments

Good time of the day, community! Hope, that my post won't irritate too much, but rather will be helpful for someone in future. I already made some progress myself (I mean some raw unfinished vers...

0 answers  ·  posted 6y ago by Anton FromButovo‭  ·  last activity 5y ago by System‭

Question software technical-writing software-documentation documentation
50%
+0 −0
Q&A Can I use LaTeX in a fictional code-weaving?

I'm working on a magic system that works with weaving types of power. The most commonly used power source is a magical code. I'm trying to base this code off of latex. LaTeX is a math code that is ...

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

Question software latex software-documentation microsoft-word documentation
50%
+0 −0
Q&A Structure for software documentation: long vs short pages

For online, developer-centered documentation for a complex software product, which structure is going to be more usable: a smaller number of long, comprehensive pages, or a larger number of more gr...

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

Question software technical-writing structure software-documentation documentation
50%
+0 −0
Q&A Alternatives better to the binary "0b..." format?

In our documentation, we write binary numbers like this: 1010 But we write hexadecimal numbers like this: 0xABAB Now, according to the GCC compiler conventions: Numbers are normally written in...

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

Question software terminology software-documentation documentation
60%
+1 −0
Q&A Terminology question - "if-else" or "if/else"?

Are they "if-else statements" or are they "if/else statements"? I'm partial to the latter, but I can see the logic of the former - both "if" and "else" are acting as a unit modifier for the noun "s...

3 answers  ·  posted 7y ago by Yoel‭  ·  last activity 5y ago by System‭

Question software terminology style software-documentation documentation
50%
+0 −0
Q&A Bridging the gap between colloquial usage and technical meaning of terms

Frequently, at least in the software world, it seems that terms get assigned a meaning over time that is more general than the original definition. REST is a good example of this. While REST refe...

3 answers  ·  posted 7y ago by thesquaregroot‭  ·  last activity 5y ago by System‭

Question software terminology software-documentation documentation
60%
+1 −0
Q&A Are there valid reasons to write Java Annotation (or .NET XML Documentation) for private methods?

At this point, many languages have some "standard" format for writing documentation for individual methods. This includes, for example, Java Annotation and Microsoft's XML Documentation for .NET La...

0 answers  ·  posted 7y ago by EJoshuaS - Reinstate Monica‭  ·  last activity 5y ago by System‭

Question software software-documentation api-documentation documentation
60%
+1 −0
Q&A Our team needs to automate many routine tasks. Can we use a single tool or do we need to use multiple ones?

Our tech comm team has a wide variety of time-consuming, repetitive tasks they we need to automate. We are mainly using Sphinx, reStructuredText, Adobe Illustrator, and Visio. Specific things we n...

1 answer  ·  posted 7y ago by David Vogel‭  ·  last activity 5y ago by System‭

Question software tools technical-writing software-documentation automation documentation
50%
+0 −0
Q&A Is it better to repeat steps listed elsewhere in a manual, or to refer the reader to where the steps are listed elsewhere in the manual?

We have a tool that we cannot replace that does not support single sourcing. As a result, with instructions that involve the same node, we either repeat the same dozen steps over and over, or refer...

2 answers  ·  posted 7y ago by Lefty G Balogh‭  ·  last activity 5y ago by System‭

Question software organization technical-writing software-documentation maintenance documentation
50%
+0 −0
Q&A What strategies are there to document data lineage and keep it updated with a minimum amount of maintenance?

Quickly communicating data lineage to other stakeholders in our organization has become increasingly difficult as we scale. What are effective strategies to address this and keep it maintained? A...

2 answers  ·  posted 7y ago by David Vogel‭  ·  last activity 5y ago by System‭

Question software technical-writing software-documentation documentation
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‭

Question software technical-writing software-documentation documentation
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‭

Question software technical-writing software-documentation documentation
50%
+0 −0
Q&A Documenting the no-args call of a command line program

I am writing the built-in help for a command line program. The exact name is irrelevant, so let's use foo as a placeholder. This utility can be called with some arguments (like foo -v) or without ...

1 answer  ·  posted 8y ago by Nick Volynkin‭  ·  last activity 5y ago by System‭

Question software technical-writing software-documentation documentation