documentation Archives | Facet Digital
Design, develop, launch, and scale your product with Facet Digital. Minimize risk, shorten your time to market, and increase your potential for success with Facet Digital as your experienced, all-in-one product development team.
web application development, mobile app development, seattle web development agency, ruby on rails, ios, html5, northwest design agency
189
archive,tag,tag-documentation,tag-189,ajax_fade,page_not_loaded,,select-theme-ver-4.4,wpb-js-composer js-comp-ver-5.4.7,vc_responsive
 

documentation Tag

August 28, 2023 In Code, Estimation, Process, Productivity, Tech Debt, Uncategorized

Top 10 Software Developer Productivity Killers

If you’ve recently found yourself trapped in a catacomb of chaotic code or entangled in a web of woefully unclear requirements, fret not! Bob’s journey through the perilous pitfalls of developer productivity is the adventure you’ve missed. Over the past two weeks, we’ve run a daily series of blog posts about the most prevalent software developer productivity killers we, at Facet Digital, often see in the engineering teams we are hired to assess. Some of these have do to with the technical team and their decisions, and some of them have to do with the business support around them.

Here’s a quick recap:

01Useless MeetingsBreaking up the Maker’s focus time
02Open-Plan OfficesNoise and visual distraction disrupt concentration
03Technical DebtShort cuts now make innovation take longer later
04Dead CodeHours wasted maintaining or searching through garbage
05Too Many Status ReportsTalking more about work than doing the work
06Unclear RequirementsSpending too much time guessing at the wrong intent
07Poor Branching StrategyWorking in too large of chunks and not getting feedback quickly
08Unrealistic / Arbitrary DeadlinesDemoralizing and stifling creativity
09MicromanagementNot letting the brains you hired use their brains to the fullest
10Poor DocumentationMaking the next dev guess and explore without a map

Familiar foes? If these productivity antagonists have been causing chaos in your dev-life, contact us for some superhero assistance.

🙋‍♀️ Encountered another productivity villain we missed? Share in the comments which dastardly devils resonate with you and any others lurking in the shadows!

August 25, 2023 In Uncategorized

Tech Docs: The Unsung Hero

Software Developer Productivity Killer #10: Lack of Good Docs

Picture this: Bob, having navigated through unclear requirements, suffocating micromanagement, and the pressure of unrealistic deadlines, comes face-to-face with… a wall. Not just any wall, but a vast, blank barrier that lacks information, direction, and clarity. This, my friends, is the wall of poor documentation.

👮‍♀️ Why Documentation is Non-Negotiable

Documentation isn’t just a sidekick; it’s the hero of software development. It’s the translator between developer lingo and the rest of the world, and between past developers and their successors.

  1. Onboarding Obstacles: New developers spend countless hours, not in producing quality code, but in decrypting existing systems, trying to understand processes, and setting up their environment. Good documentation is like a lighthouse, guiding them safely to shore.
  2. Maintenance Mayhem: Without proper documentation, diving back into a codebase becomes a guessing game. Fear of changing code creeps in, and the result is stagnation, hesitation, and decreased productivity.
  3. The Wrong Kind of Adventure: Developers love problem-solving, but being forced to explore a project blindfolded because of lack of documentation? That’s not the kind of adventure they signed up for.

📄 Essential Characteristics of Good Documentation

  • Dated and Versioned: Knowing when information was documented and which version it pertains to can be invaluable. It is imperative to be able to see and track changes to a document over time – who, what, and why.
  • Searchable and Navigable: Use platforms like Confluence or Slab to ensure your documentation can be quickly located, through both searching and intuitive navigation.
  • Templated Consistency: Uniformity in documents, like design doc templates or post-mortem templates, speeds up comprehension.
  • Location, Location, Location: Docs should reside close to their point of use. READMEs inside repositories, FAQs in the help section, architecture diagrams in wikis, and so on.
  • Stay Fresh: Outdated or irrelevant documentation can be worse than no documentation. Regularly review and prune as necessary.

🛥️ The Onboarding Advantage

A pro tip? Have your newest hires follow and enhance the onboarding documentation. This ensures a fresh set of eyes refines the process consistently.

And for a truly revolutionary approach? Consider integrating a bespoke private LLM AI system. Train it on your documentation and watch as developers simply query the system to get accurate, traceable answers straight from your archive. It’s an innovation Facet Digital is passionately pioneering.

📣 To all the leaders and developers out there, documentation is the unsung hero of productivity. Let’s give it the spotlight it deserves. And if you’re looking to revolutionize your documentation strategy, figure out how to weave it into your dev process seamlessly, or integrate cutting-edge AI solutions, please reach out. We’re here to guide your team towards unparalleled productivity.

✋ Just joining us? Take a journey from the start with our series on developer productivity killers, beginning with the very first post.