Technical Document Production, Version Control and Knowledge Management
Communicating Information through an Architecture of Knowledge
Documenting the world...just so you know!
Gary P. Swope (AKA "GPS") is a seasoned technical writer, content developer and document editor who has produced a wide variety of multi-platform informational documents in a broad assortment of media formats (PDF, HTML, HTML Help, MS Doc, Wiki, social media, printed hard copy and CD-ROM). He has produced documentation for diverse audience types and technical levels including end users, internal employees, engineers, programmers, 3rd party developers, system administrators and upper management.
When it comes to writing, Gary believes it is important to produce and deliver documents that are technically accurate, concise, effective, and professional looking.
Authoring Software: Adobe Creative Suite / Technical Communications Suite (Acrobat, Dreamweaver, FrameMaker, InDesign), Microsoft Office (Excel, PowerPoint, Visio, Word), Microsoft Expression Web, Microsoft Sharepoint, Confluence, DocBook, Google Docs, Google Sites, Javadocs, LibreOffice, Wiki.
Databases: MySQL, Oracle R11 and R12, SQL Server.
Platforms: Linux Mint, Microsoft Windows all versions, Red Hat Enterprise Linux, Sun Solaris, Ubuntu Linux, Ubuntu Studio Linux.
Graphics Software: Adobe Creative Suite (Illustrator, Photoshop), GIMP on Linux, MS Visio, Snagit, SolidWorks.
Source Control & Defect Tracking: Bugzilla, CVS, Github, Perforce, Sharepoint, Visual SourceSafe.
Technologies: Bluetooth, DNS, Ethernet, FTP, LAN / WAN, RFID, TCP/IP, VPN, Web Services, Wi-Fi.
Gary is a practitioner of all document, web, graphic and media formats. He delivers complete and comprehensive publications derived from scratch or from any number of file types (.DOC, .HTML, .PDF, .TXT, .XLS, Flash, Photoshop, FrameMaker, InDesign, Visio, Wiki and more).
Below are some of the types of technical documents Gary has produced and published.
- Application-based HELP systems
- Hardware / software installation and user manuals, guides and instructions
- Product data sheets, product training materials
- Software development kits (SDKs), software integrators guides
- Web and enterprise-based server configuration and administration guides
Engineering and Design Documentation
- API (Application Programming Interface) documentation
- Application/product requirements
- Engineering documentation
- Functional specifications
- Method of Procedures (MOP) / Run Book and Playbook documents
- Product Requirements Documentation (PRD)
- Reference design manuals
- Scope of Work (SoW)
- Standard Operating Procedures (SOP)
- System integrations process diagrams
- User interface / user experience (UI/UX) designs, layouts, mock-ups and copy
Quality Assurance (QA) Documentation
- QA databases for product defect tracking
- QA test coverage matrices
- QA test plans
Technical Support Documentation
- End user support guides
- FAQ (Frequently Asked Questions) content
- Support documentation repositories
- Application HTML help systems
- Google "Sites"
- Knowledge base repositories
- Web site articles and blogs
- Wiki intranet site design and content development
Graphics, Illustrations and Animations
- Corporate graphics
- Process flow diagrams
- Product graphics, logos and icons
- Technical illustrations and Infographiics
- User Interface mock-ups and layouts
Corporate, Sales and Marketing Documentation
- Corporate news letters, press releases, company handbooks
- Corporate technical knowledge repositories
- Department procedures
- Marketing collateral
- Sales-based web copy, technical sales literature
- Training materials, new-hire HR documentation
- White papers
Below are some of the products and services for which Gary has produced technical documentation.
- Acquisition IT and connectivity service playbooks containing instructions for integrating IT services for an acquired organization
- Bluetooth hardware - Product specifications and API commands guide
- DSL hardware - QA test plans and procedures
- Graphics accelerator chips and video cards - Product technical support documentation and Knowledge Base
- Health care industry regulatory compliance utilities - Application administration documentation
- Health care industry - user and administrator guides for enterprise customer information management system
- HR (Human Resources) and ERP (Enterprise Resource Planning) teams - Application user documentation
- Network security, anti-virus software utilities - Blog content
- RFID (Radio Frequency Identification) products - Complete product documentation.
- Set top box products for IP-based TV services - API documentation
- Vehicle manufacturing - Web services integration guide and diagrams
- Video teleconferencing endpoint deployment services - Deployment procedures, processes and process flow illustrations
- Web-based Software-as-a-Service site - UI content, application user guide and help system.
Gary creates, develops, plans, writes and edits all types of technical publications including operational, instructional and maintenance procedures, process flows, application specifications, product guides, user manuals and more.
Top 15 Ways Gary Can Help Your Organization Today
There are hundreds of ways Gary can help your organization today, but below are the top 15.
- Gathers Your Ideas: Gary compiles and converts raw data and ideas into web-based, printed or multimedia communications that transfer knowledge to your users.
- Gets You Organized: By making the organization of technical information invisible to the reader, Gary transforms disorganized information into a consistent interface and voice.
- Fixes Wording: Gary crafts congruent statements out of disjointed ideas not only in product specifications and engineering documents, but in customer facing publications. He fills in gaps in thinking to increase customer understand and appreciation of your products.
- Corrects Errors and Cuts the Clutter: Vigilant about accuracy, Gary finds flaws in logic and fixes technical errors. He flushes out technical ambiguity and removes irrelevant detail from documentation so as not to confuse your readers.
- Addresses Potential Problems: He will save your organization money by anticipating and addressing potential user support questions within the documentation, thereby reducing the demand for technical support.
- Asks Questions: Gary conducts thorough interviews with technical staff to gather data for his documentation. He presents subject-matter experts as extremely knowledgeable and articulate in product documentation. Gary makes effective use of communication practices to foster harmonious relationships with team members and subject-matter experts.
- Gives the Reader what They Want: Gary designs documentation that contributes to the creation of happy, repeat customers and to the positive public perception of your products and organization. Customers will find his documents a good reason to use and therefore continue to purchase your products (rather than those of a competitor).
- Helps the User: Gary is a user advocate, consultant, and advisor, with the customer's success in mind. Gary sees the product from an end user's view.
- Learns it, Does it: Gary takes ownership and pride in his work. He learns fast and works hard to grasp complex technical concepts.
- Suggests Change: Although he may make suggestions for improving company documentation standards, Gary does not demand changes without reason.
- Keeps Your Style: Likewise, Gary maintains corporate style guidelines and does not alter style without just cause.
- Edits and Rewrites: Gary is an accomplished editor who advises where rewriting is needed, he does not rewrite on a grand scale, unless asked.
- Juggles Multiple Publications: Capable of juggling multiple concurrent projects, Gary can also be a focused specialist. Either way, he is dependable and flexible.
- Uses Technology to Help Customers: By staying current with technical writing trends, practices, tools and technologies, Gary harnesses the latest digital architectures to convey information to customers in a variety of media formats (PDF, HTML, XML, print, social media, etc.).
- Gets it Done on Time: Gary is highly organized and proficient at delivering technical publications on time for deadline specific products.
Top 10 Advantages Your Company Will Gain with Gary:
Gary uses his experience, skills and creativity to develop and produce professional technical documentation. There are a lot of advantages that come with hiring Gary, below are just the top 10.
- Gary is a skilled documentation expert that can produce and deliver printed and Web-based documentation.
- He has experience providing Technical Support and Quality Assurance.
- He can take ideas and find solutions to difficult problems.
- As a writer, Gary is detail oriented and vigilant about accuracy, yet speedy and prompt at providing deliverables.
- He is an engineer who learns fast and works well under pressure.
- Gary is a technician with strong analytical, trouble-shooting and problem-solving skills.
- He is someone who works well with others yet is comfortable working independently.
- Gary prides himself on being responsible and dependable.
- He takes ownership and pride in everything he does.
- He is a realist who is flexible and willing to compromise.
- Bonus Advantage: Gary is someone who knows much, but is not afraid to ask questions when he does not understand something. With numerous friends, colleagues and contacts in the high-tech industries, Gary can quickly call upon a professional subject matter expert to answer a question or assist in a project when necessary.
Below are actual comments and quotes from some of Gary's managers, colleagues and clients.
Gary was, and is, one of those incredible types to manage! You don't need to give direction or guidance, but instead point him in the direction he needs to go, and he will figure it out and do it on his own! I had the tremendous opportunity to work with Gary a couple of times in the Bay Area, and I hope to have the chance to do so again in the future. Regardless of the role, Gary will be your A player!
- Mark P. (Director of Engineering and Gary's manager at Philips and Telocity).
We hired Gary to create and maintain documentation for our portfolio of products and services provided by the Video Program in Cisco IT. Gary is a great technical writer that works well with his clients' team providing great results and value.
- Firas A. (Theater IT Leader - Emerging Markets, Cisco Systems).
These look great! I appreciate you formatting the Visio files I sent you with the templates. Amazing as always Gary! Thanks,
- Faizal (Project Manager)
Hi Gary, This is really, really good. Thanks! We'd like a few more changes though; see below: Thanks again.
- Zehra (Third-Party Software Developer).
Gary - This is amazing! Thank you so much for the super quick turnaround. The diagram looks great to me. Thanks again.
- Zehra (Third-Party Software Developer - Network Standards: Campus Enterprise Design Diagram).
Gary is very detail oriented, and was a pleasure to work on projects with. He is calm under pressure while never compromising anything. Gary would be a great asset to any team.
- John E. (Portfolio Manager & Wealth Management Advisor).
Gary did a really great job, It's clear, straightforward and professional. Thanks.
- Donna S. (Senior Marcom Manager).
Gary, thanks for all your hard work in putting this together. Your creativity and initiative are impressive! .
- Joseph R. (Project Manager).
Looks great! Everything is fine. I appreciate Gary's efforts in making this happen on the internal website. Thanks.
- Sravan (Software Developer).
Hi Gary, These are excellent. I do like the format and style. We will have a meeting with Cisco reps on the 3rd and we can discuss the project with them while using these excellent slides. Thanks a lot. Best Regards.
- Seyed (Project Manager).
Hi Gary, Thank you, thank you, thank you! This looks really, really good, I may have some changes out of my meeting at 10am, if so I will let you know. Best,
- Kaylee (Project Manager).
Nope, this is perfect, thank you Gary, I really, really appreciate it!!! Best,
- Kaylee (Project Manager - BMU Diagram Rev 1.03)
Gary, thanks. This reads really well. Best regards,
- Jay P. (Vice President of Sales - Corporate Website Content Development).
Gary, really well written manual. Just a couple really minor points (may not even be worth mentioning)...Overall, really well written. The technical details and specs, I trust are okay. Regards,
- Wilbur T. (Project Manager).
Please note that a large portion of Gary's portfolio consists of printed and hard copies of lengthy manuals, guides and books. As such, he has opted to refrain from posting these large files. However, some of his portfolio samples are posted HERE and others are provided below.
For even more samples, check out Gary's Corporate Graphics and Technical Documents Gallery.
While you are here, visit Gary's Resume Page.
Below are some of the companies and clients for which Gary has produced technical documentation.
Gary's hardware diagram and feature summary for Google Glass.
Gary's "How the Data Flows" diagram for Google Glass.
Gary's device setup and initialization instructions for the Glass device.
Some of the graphics and logos Gary designed for Tesla Motors.
Gary's communications process flow diagram for Google Human Resources (GHR).
Screen capture of the GHR Tech Docs site Gary built.
A collage of Gary's GHR diagrams and graphics.
One of Gary's favorite repair jobs, the xTVFusion Platform Diagram for Minerva Networks.
Before and after images of the Platform Diagram.
Before and after images of the Set-Top-Box Components.
Gary's Dispatcher Multicast Data Streams Diagram for xTVFusion.
Gary's Network DVR and Whole Home DVR Architecture diagrams.
Gary produced all documentation, artwork, graphics and program icons for PFU Mediastaff.
This is a white paper Gary wrote for his client, EffOne.
Gary produced product user manuals for dozens of RFID products.
He also produced product graphics, box labels and card designs for RFID products.
Gary carried out measurements of magnetic fields to come up with these Antenna to Tag Range diagrams for RFID products.
One of the RFID tags for which Gary designed the graphics,
Cover of an Operator's Manual designed by Gary for RFID Gateway device.
Letter of Reference from Gary's manager.
KC Technology, Inc.