Activity for Lefty G Balogh‭

Type	On...	Excerpt	Status	Date
Edit	Post #26411	Initial revision	—	over 4 years ago
Edit	Post #26400	Initial revision	—	over 4 years ago
Edit	Post #26298	Initial revision	—	over 4 years ago
Question	—	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 the user to say chapter 2 sectionXY23 to perform steps 1-17 and then carry out step 2 and 3 from here. ... (more)	—	about 6 years ago
Question	—	Where would I specify which user is required to run an administration command? I work with a software product that has over 10 major components. The administration of most of these is done with the root user with one notable exception where they use a less privileged user for such purposes. In most places, the instructions specify the user, and may even include instructions suc... (more)	—	about 6 years ago
Question	—	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 language, a "hello world" style sample API client that shows how a few select methods and data items can ... (more)	—	about 6 years ago