I need to gather info from subject matter experts from a group at work so that I can document their procedures and reference information. I was wondering if you all had some best practices that I should follow in order to get the most thorough information, while being as helpful as possible. [more inside]
I have an ongoing research project to document and map locations of camp meetings, which originate in 19th century religious revivals. I've mapped more than 50 (listed inside), including some famous ones like Oak Bluffs, MA, Bay View, MI, and Indian Springs, GA, and am now looking for others. I'm interested in three kinds of sites: current active camp-meetings that still operate as a religious camp or revival; "legacy" sites where the camp meeting evolved into a town or incorporated secular association; and defunct sites where a camp once was before being abandoned. Any and all links, vague memories, and coordinates welcome! [more inside]
I'm in probation at a state institution of higher learning. My first year has three reviews. The first two have had poor marks (needs improvement / unacceptable!) regarding certain issues. [more inside]
Somehow I'm the guy who is ultimately responsible for writing and maintaining all of the manuals for our hardware and software products. This is a pain in the neck job that's not getting done, and I know how to describe the tool I think I need in order to relieve the pain. But does it exist? [more inside]
If you work at a forwarding thinking company that builds software, what does your process and tooling look like? I realize this is a big question, but I am very interested in how teams are working these days. Starting from an idea, how do you go about discovering, analyzing / estimating, planning / tracking, building, testing, deploying, and documenting your software? [more inside]
Tell me about what cultures, cultural practices, arts, religions, languages, lifestyles, hobbies, habits, fashion, unconventional individuals/families, or any other aspects of human life in the U.S. still remain severely underdocumented; or are at risk of fading away before they can be properly or meaningfully documented. [more inside]
I'm looking for appropriate software to start documenting and cataloging a sewing pattern archive. What would be the most appropriate? I've seen this and this, but they are a little dated and not quite what I think I need. [more inside]
How do I know I’ve taught myself enough technical writing software (number of programs and my abilities therein) for potential employers to take me seriously? [more inside]
How can I help my dad digitize his extensive collection of genealogical documentation? [more inside]
Greetings hive mind! This seems to be something that should already exist, but I think I either haven't found the right type of wiki, or have looked over the feature in one of the many wikis I've tried. Basically, I'm looking to use a wiki for IT documentation purposes...but I'd also like for it to be able to automatically propagate views/pages in a relational manner (either via the backend or via templates). Here's an example to help illustrate: [more inside]
Which websites/web services offer the very best online help portal, where you can get documentation and videos on their product? [more inside]
Which open source products do you use that have lousy documentation? [more inside]
What are good examples of technical documents? examples: business policies, research papers, references, documentation [more inside]
I am looking for examples of beautiful or unusual, yet effective, computer network diagrams - the more complex and extensive the networks, the better. Similarly, I'd like to find tutorials and how-to's on making same - preferably avoiding Visio/OmniGraffle as much as possible (most of the people I work with just want to swap .pdfs or Power Point presentations when it comes to delivering design documents, anyhow.) I deal with very intricate and large networks, and it's always a struggle to present them visually to various project stakeholders. I'd like to catch their attention with something striking that will help them actually understand what's going on.
I have to write several instructions manuals with screenshots. (Step-by-step documentation.) What's the easiest way to do this? Any hacks or software recommendations? I want it to look nice and be easy to make. I don't have access to Photoshop or Illustration; free or very low cost would be ideal.
I have two user manuals, for two version of a product, which are 75% identical. They're currently Word documents. It's a pain to keep the parts in sync that I need to keep in sync. How can I do this the best way? [more inside]
The assault occurred in Panama, while I was working for a US-based nonprofit biology field school. I'm Canadian, and never had a contract with this institution. I was assaulted by an American coworker who targets the young women he comes into contact with via this job (and other lines of work, all as a teacher). I have a recording of him admitting what he did, and two recordings of the head of the organization explaining that he wont do anything and that he knows but doesnt care that this person is a predator. The recordings were made without permission. I've been told that the federal funding this organization receives would disappear if I could somehow find that granting agency and contact them with my complaint. What I'd really like to know is whether I could publish my recordings without legal repercussion, or what the outcome might be if I did, regardless. [more inside]
I do some developery-type stuff at work and the more complicated it gets, the less organized I am. I often find myself wondering why I did this or that or what I was trying to accomplish with it. I reuse a lot of the same functions and bits of code but I don't have a good system of keeping track of them. I know about commenting within code, and I do that, but I'm looking for a larger system of general best practices more than a specific solution. [more inside]
I am writing some documentation for an app that runs on the iPhone, iPod Touch, and iPad. I need a consistant way to refer to these devices and am looking for something better than "iPhone/iPod/iPad". For example: "Hold your iPhone/iPod/iPad's camera so that the QR code is centered in the brackets." I've come up with either "... iPhone/iPod/iPad (referred to as iPhone from here on)" or "IOS device" Anyone have a better idea?
Last minute check list for US citizen with departing flight from Canada to Iceland to UK to Ireland, no return ticket and a car retuning with a different driver. [more inside]
A friend would like me to save her some posts and comments from FB in a less ephemeral way. I'd like to copy them and make them into some sort of book or pamphlet for her. Have you done this sort of thing before and if so, how? I've seen Fonicle, which I think is a bit of overkill for this situation. [more inside]
Does anyone know why academic PDF documents downloaded as full text seem to universally download as poorly documented/difficult to sort files? [more inside]
What are good tools for making app documentation videos, which focus on the specific region of interest? [more inside]
My wife, a card-carrying permanent resident alien living in the U.S., allowed her German passport to expire and is seeking a renewal through the German Consulate in New York City. She has her documentation mostly in order, including German birth certificate, but needs to show proof of a name change that took place during an adoption in Iowa when she was four years old. Difficulty: Iowa adoption records are sealed. Looking for advice on how to best request a copy of the documentation, or provide a suitable alternative. Comprehensive details inside. [more inside]
User documentation/knowledgebases: Looking for best practices, great examples, and advice/instructional sites or publications. Also open to lowlights/worst-of resources. Analysis of how users engage with documentation would be useful, too. [more inside]
I have a few thousand pages of documentation I'd like to digitize and organize, eventually making a series of PDFs out of them. Can you help me make this task less painful? [more inside]
Does anyone have any tips for dealing with less savvy users of web-based WYSIWYG products like TinyMCE (which Wordpress uses) and/or improving the usability on the back-end? The best users I've worked with seem to universally use the HTML editor, while the rest fight with the visual editor to varying degrees of success. [more inside]
Can my undocumented friend drive my car? Can I drive his car? Will my insurance cover it and am I putting myself or him (or other drivers) at any risk? [more inside]
What is the best (Mac compatible) program/thing to use to write an internal manual for my department at work? [more inside]
Can you recommend some free tools that can help generate timeline estimates? [more inside]
What's the best way to learn about formatting documents? [more inside]
Which mortgage/refi documents should have a backup copy? [more inside]
Our company needs to create an application-level "runbook". We are an enterprise-level IT organization with no formalized documentation structure. At the moment we are looking at building a custom runbook using SQL Server as a backend and Microsoft Access as a front-end, but the amount of time in doing this is immense. Is there a retail product that is set for us? [more inside]
I'm responsible for all the documentation at my workplace. I receive a few documents per day, and invariably they're somewhat badly written. So part of my process is that I edit them and clean them up before I post them on our intranet. Most folks like that I do this, but there are some who take it personally and consider the document to be "theirs" - because they wrote it. However, the document is really for other people, and if it's difficult for others to understand, or there are steps missing, or at worst it causes confusion, then it is not a good document and requires modification. How do I tactfully manage this? [more inside]
Which software projects' Web sites stand out as having really well-organized documentation? [more inside]
Help me find an off the shelf video system for documenting a technical process. [more inside]
Looking for an Application to search a file directory which contains php files (or any code, if it will work with PHP) and find all of the Database Tables which are referenced in the code, without relying on comments in the Code.
How do I actually get the documentation that I have been asking for at work? [more inside]
I need help writing a detailed technical document in "for dummies" fashion. Is there a "for dummies" style guide as opposed to a style guide for dummies? [more inside]
I am several weeks away from leaving my job for a new one. As a result, I need to document my current development efforts for the several folks who will be taking over my responsibilities. My challenge is how to organize documentation about individual components with some additional flexibility. I’m looking for a method, or software, that would allow a thorough initial organization of documentation notes, but also enable other slices or views: show me all bits that live on server X, show me all of the bits that support application Y, what applications depend on script Z, etc. [more inside]
So, please help settle a dispute between myself and my boyfriend about Mozart and the musical capabilities of the average American. [more inside]
Despite having no training whatsoever, I've gradually become 'the IT guy' at work. I want to get organized and begin building a documentation file but I have no idea where to start. [more inside]
I have a particular propriety database application that has a great feature for users to document notes and changes to the db. Annotated screenshot here. Basically, you click on the little yellow sticky note and the documentation window pops up and users can enter notes about changes, etc. Its so useful I would like to use it all the time. [more inside]
How do I access the C documentation that's on my computer? [more inside]
I am looking for real-life documents surrounding the development of a website. My organization is quite inexperienced in building a website from scratch and we are looking for some documents to get us started. Can anyone point us to some actual specifications, wireframes, test scripts, and project plans for website design and development?
Is there wiki software that is specifically designed for writing books? By "book" I mean a long piece of writing designed to be read from start to finish, possibly broken up into chapters, and possibly with a TOC at the start and index at the end. [more inside]
I am a technical writer looking to improve my company's software manuals. I want to stay up to date with the latest technology documentation trends. Please leave comments on what you think some of the best manuals are for different software products and why. Basically, if you’ve ever read a software user manual and thought, “Wow! That was surprisingly easy to read…or helpful…or well organized…etc., then that is what we are looking for.
For-a-friend-filter: Help with JavaDoc. [more inside]
Are passport expediting services legit? [more inside]
What's the best software for writing and publishing software documentation?
Page: 1 2