중복 된 유지 보수 - 코드 및 문서

Question

이것은 최상의 제목이 아닐 수 있습니다. 누군가 내 문제를 읽은 후에 누군가가 더 나은 것을 생각해 내면 감사하겠습니다. 또한 저는 인터넷에서 주로 독학을하고 있다고 말하고 싶기 때문에 제가 모르는 많은 도구가있을 수 있습니다.

Java 및 C# 모두에서 플로우 기반 프로그래밍 (FBP) 개념을 구현하는 소프트웨어를 유지 관리하고 있습니다. 이들 각각에 대해, 나에 대한 코드가 있습니다

• 내 웹 사이트
• 소스 포지 파일 릴리즈 시스템 (zip 파일 또는 jar 파일)
• 소스 포지 (SourceForge) SVN
또한

을, 나는 버전의 참조가 과에 (때로는 부분) 설명 :

• 내 웹 사이트 (HTML)
• 내 위키
• 자바 독

또한 FBP 코드의 자바 버전의 최신 버전에 대해 알고있다 내 웹 사이트 및 소스 포지에, 또한 그리기 도구가있다.

모든 것이 완전히 철저히 교차 연결되어 있지만 때로는 참조를 놓칠 수 있습니다! 며칠 전 필자는 오랫동안 내 프로젝트에 대해 SourceForge News를 업데이트하지 않았다는 것을 깨달았습니다. 그래서 나는 그렇게해야했습니다 :-)

이러한 차량 중 일부는 아마도 중복되어 있음을 알고 있지만 일반적으로, 나는 누가 무엇을보고 있는지 모른다.

제 질문은이 모든 오버 헤드를 줄이는 방법이 있는지 여부입니다. 예 : HTML "imbed"기능이 좋을 것이므로 적어도 최신 버전 번호를 한 곳에서 저장할 수 있습니다. 아마도 Java 상호 참조를 단순화 할 수 있지만 언어 간 차이는 더 클 것 같지만 추측 할 수 있습니다.

모든 아이디어를 환영합니다.

Answer 1

빌드/배포 프로세스의 일부로 문서를 업데이트하고 유지 관리하고 싶습니다.

1. 빌드
2. 단위 테스트 등
3. 컴파일 문서
4. 배포 그렇지 않으면 당신은 항상당신의 꼬리를 쫓아 될 것입니다
5. 배포 컴파일 된 문서

을 구축합니다. 분명히 문서 배포에는 어디로 갈지에 대한 다른 해결책이 필요합니다 (예 : 웹 사이트로 복사, 다른 곳에서 FTP로 전송)

나는 이것에 대한 만병 통치약이 확실하지 않습니다. 나는 속성 파일/설정 파일에 버전 번호를 유지하고 검색/대체를 적절하게 수행합니다. 가능하면 코드 문서가 코드 자체에 들어간다. 그런 다음 내 빌드에서 전처리된다 (위의 3 단계).

당신은/볼 Doxygen을 사용 했습니까? 그러면 다국어 요구 사항이 처리되며 문서 작성/유지 관리에 잘 적용됩니다. 당신이 당신의 빌드/출판 프로세스를 자동화 할 필요가 같은

Answer 2

는 소리가 난다. 이 둘은 오히려 비슷한 상황이 보인다 - 나는 잠시 다시 오라일리에 this article 읽어? 그의 해결책은 파이썬을 많이 사용하지만, 적어도 당신에게 몇 가지 아이디어를 줄 수 있습니다.

이 참으로 문제가 문제입니다